NameValuePairArray
Overview
Location
- Unit: DataAbstract4_Intf.pas
- Ancestry: TCollectionItem | TROComplexType | TROArray | NameValuePairArray
constructor Create reintroduce overload virtual (declared in TROComplexType)
Creates a new instance.
constructor Create
constructor Create (TCollection) overload override (declared in TROComplexType)
Creates a new instance with given parameter.
constructor Create(aCollection: TCollection)
Parameters:
- aCollection: collection
Add overload
function Add: NameValuePair
Add (NameValuePair): Integer overload
function Add(Value: NameValuePair): Integer
Parameters:
- Value:
Assign (TPersistent) override
procedure Assign(aSource: TPersistent)
Parameters:
- aSource:
Assign (TPersistent) override (declared in TROArray)
procedure Assign(Source: TPersistent)
Parameters:
- Source:
AssignTo override (declared in TROComplexType)
Copies the properties of an object to a destination object.
procedure AssignTo(iDest: TPersistent)
Parameters:
- iDest: destination object.
Clear override
procedure Clear
Clone (declared in TROArray)
Will create and return a second copy of the Array. The new instance will be a deep copy of the original array; if the members are structs, binaries or arrays themselves, they too will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent of the original class.
function Clone: TROArray
Clone (declared in TROComplexType)
Creates and returns a second copy of the struct.
The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.
function Clone: TROComplexType
ContentAsString (declared in TROComplexType)
Returns the structure of the type in a string format.
property ContentAsString: string read
ContentAsXml (declared in TROComplexType)
Returns the XML structure of the type in a string format.
property ContentAsXml: ROUTF8String read
Count
property Count: Integer read
Delete (Integer) override
procedure Delete(aIndex: Integer)
Parameters:
- aIndex:
Delete (Integer) virtual abstract (declared in TROArray)
Deletes the i-th element of the array. If it is struct, binary or other array, it will be freed before the element is deleted.
procedure Delete(Index: Integer)
Parameters:
- Index: Index
FieldCount (declared in TROComplexType)
property FieldCount: Integer read
FieldInfo (declared in TROComplexType)
property FieldInfo[Index: Integer]: PTypeInfo read
FieldName (declared in TROComplexType)
property FieldName[Index: Integer]: string read
FreeInternalProperties protected virtual (declared in TROComplexType)
procedure FreeInternalProperties
GetAttributeCount virtual (declared in TROComplexType)
Returns the number of custom attributes defined for the class.
class function GetAttributeCount: Integer
GetAttributeName virtual (declared in TROComplexType)
Returns the name of custom attribute defined for the class, with the specified index.
class function GetAttributeName(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetAttributeValue virtual (declared in TROComplexType)
Returns the value of custom attribute defined for the class, with the specified index.
class function GetAttributeValue(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetContentAsXml protected (declared in TROComplexType)
Returns the xml structure of the struct in a string format.
function GetContentAsXml: ROUTF8String
GetContentAsXml2 protected override (declared in TROArray)
procedure GetContentAsXml2(const aXMLNode: IUnknown)
Parameters:
- aXMLNode:
GetCount protected override
function GetCount: Integer
GetEnumerator
function GetEnumerator: NameValuePairArrayEnumerator
GetFieldNames (declared in TROComplexType)
procedure GetFieldNames(aList: TStrings)
Parameters:
- aList:
GetFieldValue (declared in TROComplexType)
function GetFieldValue(const aFieldName: string): Variant
Parameters:
- aFieldName:
GetIndex (string, Variant, Integer, TROSearchOptions): Integer overload virtual (declared in TROArray)
Searches for an item with a aPropertyName
property, which is accessible via |GetPropValue and is equal to aPropertyValue
.
Returns the index of the first item found or -1
.
function GetIndex(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): Integer
Parameters:
- aPropertyName: Name of the
published
property - aPropertyValue: Value of the property
- StartFrom: Item index to start from
- Options: Set of TROSearchOption
GetItemClass override
class function GetItemClass: TClass
GetItemRef (Integer): Pointer override
function GetItemRef(aIndex: Integer): Pointer
Parameters:
- aIndex:
GetItemRef (Integer): Pointer virtual abstract (declared in TROArray)
Returns the pointer to the array element specified by the index.
function GetItemRef(Index: Integer): Pointer
Parameters:
- Index: Item position
GetItems protected
function GetItems(aIndex: Integer): NameValuePair
Parameters:
- aIndex:
GetItemSize override
class function GetItemSize: Integer
GetItemType override
class function GetItemType: PTypeInfo
Grow protected virtual
procedure Grow
InnerArray
property InnerArray: NameValuePairArray_NameValuePair read
IntResize protected override
procedure IntResize(anElementCount: Integer; AllocItems: Boolean)
Parameters:
- anElementCount:
- AllocItems:
Items
property Items[Index: Integer]: NameValuePair read write
ReadComplex override
procedure ReadComplex(aSerializer: TObject)
Parameters:
- aSerializer:
Resize (declared in TROArray)
Resizes the array to the specified size.
Since arrays are not a very dynamic data structure, repeatedly adding single elements can be a costly procedure, since memory needs to be reallocated for the grown array with each addittion. If the final size of the array is known in advance, it will perform better if you size it to the proper count in advance, and then simply fill the new vacancies.
procedure Resize(ElementCount: Integer)
Parameters:
- ElementCount: new size
Search (string, Variant, Integer, TROSearchOptions): TCollectionItem overload (declared in TROArray)
Searches item with specified properties
function Search(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): TCollectionItem
Parameters:
- aPropertyName: property name
- aPropertyValue: property value
- StartFrom: index
- Options: options
SetFieldValue (declared in TROComplexType)
procedure SetFieldValue(const aFieldName: string; const aValue: Variant)
Parameters:
- aFieldName:
- aValue:
SetItemRef (Integer, Pointer) override
procedure SetItemRef(aIndex: Integer; Ref: Pointer)
Parameters:
- aIndex:
- Ref:
SetItemRef (Integer, Pointer) virtual (declared in TROArray)
MUST be overwritten for arrays of non-simple types.
procedure SetItemRef(Index: Integer; Ref: Pointer)
Parameters:
- Index: Item position
- Ref: Reference to object
SetItems protected
procedure SetItems(aIndex: Integer; Value: NameValuePair)
Parameters:
- aIndex:
- Value:
SmartAssign (declared in TROComplexType)
Copies specific data from a given source.
procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)
Parameters:
- Source: Instance whose properties will be copied
- TypeKinds: Specifies which properties should be copied
TryGetAttribute (declared in TROComplexType)
class function TryGetAttribute(aName: string; out aValue: string): Boolean
Parameters:
- aName:
- aValue:
WriteComplex override
procedure WriteComplex(aSerializer: TObject)
Parameters:
- aSerializer:
ContentAsString (declared in TROComplexType)
Returns the structure of the type in a string format.
property ContentAsString: string read
ContentAsXml (declared in TROComplexType)
Returns the XML structure of the type in a string format.
property ContentAsXml: ROUTF8String read
Count
property Count: Integer read
FieldCount (declared in TROComplexType)
property FieldCount: Integer read
FieldInfo (declared in TROComplexType)
property FieldInfo[Index: Integer]: PTypeInfo read
FieldName (declared in TROComplexType)
property FieldName[Index: Integer]: string read
InnerArray
property InnerArray: NameValuePairArray_NameValuePair read
Items
property Items[Index: Integer]: NameValuePair read write
GetAttributeCount virtual (declared in TROComplexType)
Returns the number of custom attributes defined for the class.
class function GetAttributeCount: Integer
GetAttributeName virtual (declared in TROComplexType)
Returns the name of custom attribute defined for the class, with the specified index.
class function GetAttributeName(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetAttributeValue virtual (declared in TROComplexType)
Returns the value of custom attribute defined for the class, with the specified index.
class function GetAttributeValue(aIndex: Integer): string
Parameters:
- aIndex: The index of attribute.
GetItemClass override
class function GetItemClass: TClass
GetItemSize override
class function GetItemSize: Integer
GetItemType override
class function GetItemType: PTypeInfo
TryGetAttribute (declared in TROComplexType)
class function TryGetAttribute(aName: string; out aValue: string): Boolean
Parameters:
- aName:
- aValue:
constructor Create reintroduce overload virtual (declared in TROComplexType)
Creates a new instance.
constructor Create
constructor Create (TCollection) overload override (declared in TROComplexType)
Creates a new instance with given parameter.
constructor Create(aCollection: TCollection)
Parameters:
- aCollection: collection
Add overload
function Add: NameValuePair
Add (NameValuePair): Integer overload
function Add(Value: NameValuePair): Integer
Parameters:
- Value:
Assign (TPersistent) override
procedure Assign(aSource: TPersistent)
Parameters:
- aSource:
Assign (TPersistent) override (declared in TROArray)
procedure Assign(Source: TPersistent)
Parameters:
- Source:
AssignTo override (declared in TROComplexType)
Copies the properties of an object to a destination object.
procedure AssignTo(iDest: TPersistent)
Parameters:
- iDest: destination object.
Clear override
procedure Clear
Clone (declared in TROArray)
Will create and return a second copy of the Array. The new instance will be a deep copy of the original array; if the members are structs, binaries or arrays themselves, they too will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent of the original class.
function Clone: TROArray
Clone (declared in TROComplexType)
Creates and returns a second copy of the struct.
The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.
function Clone: TROComplexType
Delete (Integer) override
procedure Delete(aIndex: Integer)
Parameters:
- aIndex:
Delete (Integer) virtual abstract (declared in TROArray)
Deletes the i-th element of the array. If it is struct, binary or other array, it will be freed before the element is deleted.
procedure Delete(Index: Integer)
Parameters:
- Index: Index
FreeInternalProperties protected virtual (declared in TROComplexType)
procedure FreeInternalProperties
GetContentAsXml protected (declared in TROComplexType)
Returns the xml structure of the struct in a string format.
function GetContentAsXml: ROUTF8String
GetContentAsXml2 protected override (declared in TROArray)
procedure GetContentAsXml2(const aXMLNode: IUnknown)
Parameters:
- aXMLNode:
GetCount protected override
function GetCount: Integer
GetEnumerator
function GetEnumerator: NameValuePairArrayEnumerator
GetFieldNames (declared in TROComplexType)
procedure GetFieldNames(aList: TStrings)
Parameters:
- aList:
GetFieldValue (declared in TROComplexType)
function GetFieldValue(const aFieldName: string): Variant
Parameters:
- aFieldName:
GetIndex (string, Variant, Integer, TROSearchOptions): Integer overload virtual (declared in TROArray)
Searches for an item with a aPropertyName
property, which is accessible via |GetPropValue and is equal to aPropertyValue
.
Returns the index of the first item found or -1
.
function GetIndex(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): Integer
Parameters:
- aPropertyName: Name of the
published
property - aPropertyValue: Value of the property
- StartFrom: Item index to start from
- Options: Set of TROSearchOption
GetItemRef (Integer): Pointer override
function GetItemRef(aIndex: Integer): Pointer
Parameters:
- aIndex:
GetItemRef (Integer): Pointer virtual abstract (declared in TROArray)
Returns the pointer to the array element specified by the index.
function GetItemRef(Index: Integer): Pointer
Parameters:
- Index: Item position
GetItems protected
function GetItems(aIndex: Integer): NameValuePair
Parameters:
- aIndex:
Grow protected virtual
procedure Grow
IntResize protected override
procedure IntResize(anElementCount: Integer; AllocItems: Boolean)
Parameters:
- anElementCount:
- AllocItems:
ReadComplex override
procedure ReadComplex(aSerializer: TObject)
Parameters:
- aSerializer:
Resize (declared in TROArray)
Resizes the array to the specified size.
Since arrays are not a very dynamic data structure, repeatedly adding single elements can be a costly procedure, since memory needs to be reallocated for the grown array with each addittion. If the final size of the array is known in advance, it will perform better if you size it to the proper count in advance, and then simply fill the new vacancies.
procedure Resize(ElementCount: Integer)
Parameters:
- ElementCount: new size
Search (string, Variant, Integer, TROSearchOptions): TCollectionItem overload (declared in TROArray)
Searches item with specified properties
function Search(const aPropertyName: string; const aPropertyValue: Variant; StartFrom: Integer; Options: TROSearchOptions): TCollectionItem
Parameters:
- aPropertyName: property name
- aPropertyValue: property value
- StartFrom: index
- Options: options
SetFieldValue (declared in TROComplexType)
procedure SetFieldValue(const aFieldName: string; const aValue: Variant)
Parameters:
- aFieldName:
- aValue:
SetItemRef (Integer, Pointer) override
procedure SetItemRef(aIndex: Integer; Ref: Pointer)
Parameters:
- aIndex:
- Ref:
SetItemRef (Integer, Pointer) virtual (declared in TROArray)
MUST be overwritten for arrays of non-simple types.
procedure SetItemRef(Index: Integer; Ref: Pointer)
Parameters:
- Index: Item position
- Ref: Reference to object
SetItems protected
procedure SetItems(aIndex: Integer; Value: NameValuePair)
Parameters:
- aIndex:
- Value:
SmartAssign (declared in TROComplexType)
Copies specific data from a given source.
procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)
Parameters:
- Source: Instance whose properties will be copied
- TypeKinds: Specifies which properties should be copied
WriteComplex override
procedure WriteComplex(aSerializer: TObject)
Parameters:
- aSerializer: