Skip to content

KVSKBAGenericEventArguments#

Procedures#

GetName() : Text#

Summary: Gets the name of the event.

procedure GetName(): Text

Returns: The current event name

SetName(Text) :#

Summary: Sets the name of the event.

procedure SetName(EventNamePar: Text):

Parameters:

  • EventNamePar: The event name to set

HasName(Text) : Boolean#

Summary: Checks if the event has a specific name.

procedure HasName(EventNamePar: Text): Boolean

Parameters:

  • EventNamePar: The event name to check against

Returns: Boolean indicating whether the event name matches

SetProperty(Text, Variant) :#

Summary: Sets a property with a given name and value.

procedure SetProperty(PropertyNamePar: Text; PropertyValuePar: Variant):

Parameters:

  • PropertyNamePar: The name of the property to set
  • PropertyValuePar: The value to assign to the property

Remarks: Throws an error if the property name is already in use. Handles both simple and complex data types

GetProperty(Text, Variant) :#

Summary: Gets the value of a property by name.

procedure GetProperty(PropertyNamePar: Text; var PropertyValuePar: Variant):

Parameters:

  • PropertyNamePar: The name of the property to retrieve
  • PropertyValuePar: Variable to store the retrieved property value

Remarks: Throws an error if the property name is not found

GetPropertyAsBoolean(Text[250]) : Boolean#

Summary: Gets a property value as a Boolean.

procedure GetPropertyAsBoolean(PropertyNamePar: Text[250]): Boolean

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a Boolean

GetPropertyAsDate(Text[250]) : Date#

Summary: Gets a property value as a Date.

procedure GetPropertyAsDate(PropertyNamePar: Text[250]): Date

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a Date

GetPropertyAsTime(Text[250]) : Time#

Summary: Gets a property value as a Time.

procedure GetPropertyAsTime(PropertyNamePar: Text[250]): Time

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a Time

GetPropertyAsDateTime(Text[250]) : DateTime#

Summary: Gets a property value as a DateTime.

procedure GetPropertyAsDateTime(PropertyNamePar: Text[250]): DateTime

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a DateTime

GetPropertyAsInteger(Text[250]) : Integer#

Summary: Gets a property value as an Integer.

procedure GetPropertyAsInteger(PropertyNamePar: Text[250]): Integer

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as an Integer

GetPropertyAsCode(Text[250]) : Code[250]#

Summary: Gets a property value as a Code.

procedure GetPropertyAsCode(PropertyNamePar: Text[250]): Code[250]

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a Code[250]

GetPropertyAsDecimal(Text[250]) : Decimal#

Summary: Gets a property value as a Decimal.

procedure GetPropertyAsDecimal(PropertyNamePar: Text[250]): Decimal

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as a Decimal

GetPropertyAsDateFormula(Text[250], DateFormula) : Decimal#

Summary: Gets a property value as a DateFormula.

procedure GetPropertyAsDateFormula(PropertyNamePar: Text[250]; var DateFormulaPar: DateFormula): Decimal

Parameters:

  • PropertyNamePar: The name of the property to retrieve
  • DateFormulaPar: Variable to store the retrieved DateFormula value

Returns: Always returns 0 (Decimal)

GetPropertyAsRecordID(Text[250], RecordId) : Decimal#

Summary: Gets a property value as a RecordID.

procedure GetPropertyAsRecordID(PropertyNamePar: Text[250]; var RecordIdPar: RecordId): Decimal

Parameters:

  • PropertyNamePar: The name of the property to retrieve
  • RecordIdPar: Variable to store the retrieved RecordID value

Returns: Always returns 0 (Decimal)

GetPropertyAsText(Text[250]) : Text#

Summary: Gets a property value as Text.

procedure GetPropertyAsText(PropertyNamePar: Text[250]): Text

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as Text

GetPropertyAsOption(Text[250]) : Integer#

Summary: Gets a property value as an Option (Integer).

procedure GetPropertyAsOption(PropertyNamePar: Text[250]): Integer

Parameters:

  • PropertyNamePar: The name of the property to retrieve

Returns: The property value as an Integer representing the Option value

SetHandled(Boolean) :#

Summary: Sets the handled flag for the event.

procedure SetHandled(HandledPar: Boolean):

Parameters:

  • HandledPar: Boolean indicating whether the event has been handled

IsHandled() : Boolean#

Summary: Checks if the event has been handled.

procedure IsHandled(): Boolean

Returns: Boolean indicating whether the event has been handled

SetEventContext(Code[50], Code[50], Code[50]) :#

Summary: Sets the event context with up to three context codes.

procedure SetEventContext(EventContext1Par: Code[50]; EventContext2Par: Code[50]; EventContext3Par: Code[50]):

Parameters:

  • EventContext1Par: First context code
  • EventContext2Par: Second context code
  • EventContext3Par: Third context code

GetEventContext(Code[50], Code[50], Code[50]) :#

Summary: Gets the event context codes.

procedure GetEventContext(var EventContext1Par: Code[50]; var EventContext2Par: Code[50]; var EventContext3Par: Code[50]):

Parameters:

  • EventContext1Par: Variable to store the first context code
  • EventContext2Par: Variable to store the second context code
  • EventContext3Par: Variable to store the third context code

SetFailed(Boolean) :#

Summary: Sets the failed flag for the event.

procedure SetFailed(FailedPar: Boolean):

Parameters:

  • FailedPar: Boolean indicating whether the event has failed

IsFailed() : Boolean#

Summary: Checks if the event has failed.

procedure IsFailed(): Boolean

Returns: Boolean indicating whether the event has failed

SetErrorMessage(Text) :#

Summary: Sets an error message for the event.

procedure SetErrorMessage(ErrorMessagePar: Text):

Parameters:

  • ErrorMessagePar: The error message text to set

GetErrorMessage() : Text#

Summary: Gets the error message for the event.

procedure GetErrorMessage(): Text

Returns: The current error message text

ExistsProperty(Text) : Boolean#

Summary: Checks if a property with the given name exists.

procedure ExistsProperty(PropertyNamePar: Text): Boolean

Parameters:

  • PropertyNamePar: The name of the property to check

Returns: Boolean indicating whether the property exists

GetPropertyNames(Record KVSKBAExtendedNameValueBuffer) :#

Summary: Gets all property names into a temporary buffer.

procedure GetPropertyNames(var PropertyNamesBufferPar: Record "KVSKBAExtendedNameValueBuffer" temporary):

Parameters:

  • PropertyNamesBufferPar: Temporary buffer to store all property names

Remarks: Clears the buffer and populates it with all existing property names