Class TMacroParam

Unit

xomMacroParser

Declaration

type TMacroParam = class(TXOMObject)

Description

Hierarchy

• TXOMObject
• TMacroParam

Overview

Fields

	_SkipStorage: Boolean;
	_IsArrayElement: Boolean;

Methods

	class function DoubleToDataStr(const ANum: Double): WideString;
	procedure AfterConstruction; override;
	procedure BeforeDestruction; override;
	procedure Assign (_Source: TObject); override;
	procedure CleanAssignParam (AParam: TMacroParam); virtual;
	procedure NoValueAssignParam (AParam: TMacroParam); virtual;
	procedure AssignContent (ASource: TMacroParam; AMultiStates: Boolean = False; AUpdateEditState: Boolean = False); virtual;
	procedure AssignEditDetails (ASource: TMacroParam); virtual;
	procedure Reset;
	function IsStateEdited: Boolean;
	function ResetEditState (AParamNotify: TNotifyEvent = nil): Boolean;
	procedure ChangeEditState (AOldStates: TMacroParamEditStates; ANewState: TMacroParamEditState; AOnlyFilled: Boolean = False);
	procedure ChangeEditStateForFilled (ANewState: TMacroParamEditState);
	procedure MirrorEditStateForFilled (ASourceXMP: TMacroParamModel);
	procedure ToggleEditState;
	function IsTechnical: Boolean;
	function StrContentStr (const ASeparator: WideString): WideString;
	function XMLContentValue: WideString;
	function EnumValidValuesToStrings (Items: TxomStrings; ARefParam: TMacroParam = nil): Integer;
	procedure InitializeWithLanguageQualifier;
	function AddCustomParam (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType; const ADataType: TMacroParamDataType = dtString; const AEditType: TMacroParamEditType = etDefault): TMacroParam;
	function AddArrayElement (const AContent: Variant): TMacroParam;
	function AddValidValue (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType = ptConstant; const AEditType: TMacroParamEditType = etDefault): TMacroParam;
	function AddQualifier (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType; const ADataType: TMacroParamDataType = dtString; const AEditType: TMacroParamEditType = etDefault): TMacroParam;
	function GetQualifiedParamContent(const AQualifier: WideString): Variant;
	procedure SetQualifiedParamContent(const AQualifier: WideString; const AValue: Variant);
	procedure SaveToFile (const AFileName: WideString); override;
	procedure LoadFromFile (const AFileName: WideString); override;
	procedure ImportFromFile (const AFileName: WideString);
	procedure ImportFromParam (AParam: TMacroParam);
	function HasExtraNameSpaces: Boolean;

Properties

	property CaptionText: WideString read GetCaptionText;
	property StrContent: WideString read GetStrContent;
	property DataStrContent: WideString read GetDataStrContent;
	property ParentParam: TMacroParam read GetParentParam;
	property PreEditedContent: Variant read FPreEditedContent write FPreEditedContent;
	property ReferencedParamCommand: WideString read GetReferencedParamCommand;
	property ParamContent: Variant read FParamContent write FParamContent;
	property ParamValue: Variant read FParamValue write FParamValue;
	property DateTimeZone: Double read FDateTimeZone write FDateTimeZone;
	property Original: TMacroParam read FOriginal write FOriginal;
	property Content: Variant read FParamContent write FParamContent stored False;
	property Value: Variant read FParamValue write FParamValue stored False;
	property VersionGUID: String read FVersionGUID write FVersionGUID;
	property ParamName: WideString read FParamName write FParamName;
	property ParamCommand: WideString read FParamCommand write FParamCommand;
	property ParamType: TMacroParamType read FParamType write FParamType;
	property Id: WideString read FId write FId;
	property Tag: PtrInt read FTag write FTag;
	property DataType: TMacroParamDataType read FDataType write FDataType;
	property EditType: TMacroParamEditType read FEditType write FEditType;
	property IsCondition: Boolean read GetIsCondition write SetIsCondition;
	property IsEmpty: Boolean read GetIsEmpty stored False;
	property IsInStructure: Boolean read GetIsInStructure stored False;
	property ParentStructureParam: TMacroParam read GetParentStructureParam stored False;
	property ConditionParam: TMacroParam read FConditionParam write FConditionParam;
	property FixedCondition: Boolean read FFixedCondition write FFixedCondition;
	property ConditionType: TMacroParamConditionType read FConditionType write FConditionType;
	property Description: WideString read FDescription write FDescription;
	property MaxBagSize: Integer read FMaxBagSize write FMaxBagSize;
	property AllowConditional: Boolean read FAllowConditional write FAllowConditional;
	property ArrayElementName: WideString read FArrayElementName write SetArrayElementName;
	property ArrayElementParamType: TMacroParamType read FArrayElementParamType write SetArrayElementParamType;
	property ArrayElementEditType: TMacroParamEditType read FArrayElementEditType write FArrayElementEditType;
	property ArrayElementStructureId: WideString read FArrayElementStructureId write FArrayElementStructureId;
	property ExtraNameSpaces: TMacroNameSpaces read GetExtraNameSpaces write FExtraNameSpaces;
	property ArrayRecursive: Boolean read FArrayRecursive write SetArrayRecursive;
	property EditState: TMacroParamEditState read FEditState write SetEditState;
	property EditStateOnlyEmpty: Boolean read FEditStateOnlyEmpty write SetEditStateOnlyEmpty;
	property AllowCascade: Boolean read FAllowCascade write FAllowCascade;
	property SubParams: TMacroParams read GetSubParams write FSubParams;
	property CustomParams: TMacroParams read GetCustomParams write FCustomParams;
	property ArrayContent: TMacroParams read GetArrayContent write FArrayContent;
	property ValidValues: TMacroParams read GetValidValues write FValidValues;
	property Qualifiers: TMacroParams read GetQualifiers write FQualifiers;

Description

Fields

	_SkipStorage: Boolean;

	_IsArrayElement: Boolean;

Methods

	class function DoubleToDataStr(const ANum: Double): WideString;

	procedure AfterConstruction; override;

	procedure BeforeDestruction; override;

	procedure Assign (_Source: TObject); override;

	procedure CleanAssignParam (AParam: TMacroParam); virtual;

	procedure NoValueAssignParam (AParam: TMacroParam); virtual;

	procedure AssignContent (ASource: TMacroParam; AMultiStates: Boolean = False; AUpdateEditState: Boolean = False); virtual;

	procedure AssignEditDetails (ASource: TMacroParam); virtual;

	procedure Reset;

	function IsStateEdited: Boolean;

	function ResetEditState (AParamNotify: TNotifyEvent = nil): Boolean;

	procedure ChangeEditState (AOldStates: TMacroParamEditStates; ANewState: TMacroParamEditState; AOnlyFilled: Boolean = False);

	procedure ChangeEditStateForFilled (ANewState: TMacroParamEditState);

	procedure MirrorEditStateForFilled (ASourceXMP: TMacroParamModel);

	procedure ToggleEditState;

	function IsTechnical: Boolean;

	function StrContentStr (const ASeparator: WideString): WideString;

	function XMLContentValue: WideString;

	function EnumValidValuesToStrings (Items: TxomStrings; ARefParam: TMacroParam = nil): Integer;
returns the matching index

	procedure InitializeWithLanguageQualifier;

	function AddCustomParam (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType; const ADataType: TMacroParamDataType = dtString; const AEditType: TMacroParamEditType = etDefault): TMacroParam;

	function AddArrayElement (const AContent: Variant): TMacroParam;

	function AddValidValue (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType = ptConstant; const AEditType: TMacroParamEditType = etDefault): TMacroParam;

	function AddQualifier (const AName, ACommand: WideString; const AContent: Variant; const AType: TMacroParamType; const ADataType: TMacroParamDataType = dtString; const AEditType: TMacroParamEditType = etDefault): TMacroParam;

	function GetQualifiedParamContent(const AQualifier: WideString): Variant;

	procedure SetQualifiedParamContent(const AQualifier: WideString; const AValue: Variant);

	procedure SaveToFile (const AFileName: WideString); override;

	procedure LoadFromFile (const AFileName: WideString); override;

	procedure ImportFromFile (const AFileName: WideString);

	procedure ImportFromParam (AParam: TMacroParam);

	function HasExtraNameSpaces: Boolean;

Properties

	property CaptionText: WideString read GetCaptionText;

	property StrContent: WideString read GetStrContent;

	property DataStrContent: WideString read GetDataStrContent;

	property ParentParam: TMacroParam read GetParentParam;

	property PreEditedContent: Variant read FPreEditedContent write FPreEditedContent;

	property ReferencedParamCommand: WideString read GetReferencedParamCommand;

	property ParamContent: Variant read FParamContent write FParamContent;

	property ParamValue: Variant read FParamValue write FParamValue;

	property DateTimeZone: Double read FDateTimeZone write FDateTimeZone;

	property Original: TMacroParam read FOriginal write FOriginal;

	property Content: Variant read FParamContent write FParamContent stored False;

	property Value: Variant read FParamValue write FParamValue stored False;

	property VersionGUID: String read FVersionGUID write FVersionGUID;

	property ParamName: WideString read FParamName write FParamName;

	property ParamCommand: WideString read FParamCommand write FParamCommand;

	property ParamType: TMacroParamType read FParamType write FParamType;

	property Id: WideString read FId write FId;

	property Tag: PtrInt read FTag write FTag;

	property DataType: TMacroParamDataType read FDataType write FDataType;

	property EditType: TMacroParamEditType read FEditType write FEditType;

	property IsCondition: Boolean read GetIsCondition write SetIsCondition;

	property IsEmpty: Boolean read GetIsEmpty stored False;

	property IsInStructure: Boolean read GetIsInStructure stored False;

	property ParentStructureParam: TMacroParam read GetParentStructureParam stored False;

	property ConditionParam: TMacroParam read FConditionParam write FConditionParam;

	property FixedCondition: Boolean read FFixedCondition write FFixedCondition;

	property ConditionType: TMacroParamConditionType read FConditionType write FConditionType;

	property Description: WideString read FDescription write FDescription;

	property MaxBagSize: Integer read FMaxBagSize write FMaxBagSize;

	property AllowConditional: Boolean read FAllowConditional write FAllowConditional;

	property ArrayElementName: WideString read FArrayElementName write SetArrayElementName;

	property ArrayElementParamType: TMacroParamType read FArrayElementParamType write SetArrayElementParamType;

	property ArrayElementEditType: TMacroParamEditType read FArrayElementEditType write FArrayElementEditType;

	property ArrayElementStructureId: WideString read FArrayElementStructureId write FArrayElementStructureId;

	property ExtraNameSpaces: TMacroNameSpaces read GetExtraNameSpaces write FExtraNameSpaces;

	property ArrayRecursive: Boolean read FArrayRecursive write SetArrayRecursive;

	property EditState: TMacroParamEditState read FEditState write SetEditState;

	property EditStateOnlyEmpty: Boolean read FEditStateOnlyEmpty write SetEditStateOnlyEmpty;

	property AllowCascade: Boolean read FAllowCascade write FAllowCascade;

	property SubParams: TMacroParams read GetSubParams write FSubParams;

	property CustomParams: TMacroParams read GetCustomParams write FCustomParams;

	property ArrayContent: TMacroParams read GetArrayContent write FArrayContent;
structures

	property ValidValues: TMacroParams read GetValidValues write FValidValues;
content for arrays

	property Qualifiers: TMacroParams read GetQualifiers write FQualifiers;
look up values