Interface IST_XMLPropPointer

Instance of a property of a specific type. Data tree element

Namespace: STXMLPropTypes

Assembly: STXMLPropTypes.dll

Syntax

[Guid("C0DD421D-53CB-4E7F-91D9-E5E1A6E62280")]
public interface IST_XMLPropPointer

Properties

Arr[string]

Declaration

IST_XMLPropArray Arr[string Name] { get; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
IST_XMLPropArray

Attribute[string]

Declaration

string Attribute[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
string

AttributeBol[string]

Declaration

bool AttributeBol[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
bool

AttributeExists[string]

Declaration

bool AttributeExists[string Name] { get; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
bool

AttributeFlt[string]

Declaration

double AttributeFlt[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
double

AttributeInt[string]

Declaration

int AttributeInt[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
int

AttributesList

Attributes list

Declaration

IST_XMLPropAttributesList AttributesList { get; }

Property Value

Type	Description
IST_XMLPropAttributesList

Bol[string]

Declaration

bool Bol[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
bool

CStr[string]

Declaration

string CStr[string Name] { get; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
string

Caption

Property caption

Declaration

string Caption { get; }

Property Value

Type	Description
string

Child

Child property

Declaration

IST_XMLPropPointer Child { get; }

Property Value

Type	Description
IST_XMLPropPointer

DataText

XML representation of the property

Declaration

string DataText { get; }

Property Value

Type	Description
string

DefaultValue

Default property value

Declaration

string DefaultValue { get; }

Property Value

Type	Description
string

Descriptor

Property descriptor

Declaration

IST_XMLPropDescriptor Descriptor { get; }

Property Value

Type	Description
IST_XMLPropDescriptor

Flt[string]

Declaration

double Flt[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
double

Int[string]

Declaration

int Int[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
int

IsComputed

Is computed property

Declaration

bool IsComputed { get; }

Property Value

Type	Description
bool

IsEnabled

Enabled state of the property

Declaration

bool IsEnabled { get; set; }

Property Value

Type	Description
bool

IsObsolete

Return True, if the property is obsolete and shouldn't be used in new versions

Declaration

bool IsObsolete { get; }

Property Value

Type	Description
bool

IsReadOnly

Is the property read-only

Declaration

bool IsReadOnly { get; }

Property Value

Type	Description
bool

Name

Property name

Declaration

string Name { get; }

Property Value

Type	Description
string

NodeValue

Property value as text

Declaration

string NodeValue { get; set; }

Property Value

Type	Description
string

ParamType

Property type

Declaration

string ParamType { get; }

Property Value

Type	Description
string

Parent

Parent property

Declaration

IST_XMLPropPointer Parent { get; }

Property Value

Type	Description
IST_XMLPropPointer

PropEnabled[string]

Declaration

bool PropEnabled[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
bool

PropExists[string]

Declaration

bool PropExists[string Name] { get; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
bool

Ptr[string]

Declaration

IST_XMLPropPointer Ptr[string Name] { get; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
IST_XMLPropPointer

RawAttribute[string]

Declaration

string RawAttribute[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
string

SaveToFileMark

Save to file mark

Declaration

bool SaveToFileMark { get; set; }

Property Value

Type	Description
bool

Sibling

Sibling property

Declaration

IST_XMLPropPointer Sibling { get; }

Property Value

Type	Description
IST_XMLPropPointer

SimpleType

Simple property type

Declaration

TSTSimplePropType SimpleType { get; }

Property Value

Type	Description
TSTSimplePropType

Str[string]

Declaration

string Str[string Name] { get; set; }

Parameters

Type	Name	Description
string	Name

Property Value

Type	Description
string

UpdateCount

Number of pending BeginUpdate calls

Declaration

int UpdateCount { get; }

Property Value

Type	Description
int

UpdateStamp

Declaration

ulong UpdateStamp { get; }

Property Value

Type	Description
ulong

Updated

Return True, if the property (or any of its child properties) was updated during Begin-EndUpdate

Declaration

bool Updated { get; set; }

Property Value

Type	Description
bool

ValueAsBoolean

Get the value of the corresponding type

Declaration

bool ValueAsBoolean { get; set; }

Property Value

Type	Description
bool

ValueAsCalculatedString

Value as calculated string

Declaration

string ValueAsCalculatedString { get; }

Property Value

Type	Description
string

ValueAsDouble

Value as double

Declaration

double ValueAsDouble { get; set; }

Property Value

Type	Description
double

ValueAsInteger

Value as integer

Declaration

int ValueAsInteger { get; set; }

Property Value

Type	Description
int

ValueAsString

Value as string

Declaration

string ValueAsString { get; set; }

Property Value

Type	Description
string

Version

XML property version (ReadVer), which may not match the XML type version

Declaration

int Version { get; set; }

Property Value

Type	Description
int

Methods

AddEventsHandler(string, IST_AbstractPropEventsHandler)

Subscribe to XML property event tracking

Declaration

void AddEventsHandler(string Name, IST_AbstractPropEventsHandler Handler)

Parameters

Type	Name	Description
string	Name	Event name
IST_AbstractPropEventsHandler	Handler	Event handler

Assign(IST_XMLPropPointer)

Copy data from another property

Declaration

void Assign(IST_XMLPropPointer Src)

Parameters

Type	Name	Description
IST_XMLPropPointer	Src

AssignHandlers(IST_XMLPropPointer)

Copy event handlers from another similar property

Declaration

void AssignHandlers(IST_XMLPropPointer Src)

Parameters

Type	Name	Description
IST_XMLPropPointer	Src

BeginUpdate()

Declaration

void BeginUpdate()

ClearHandlersList()

Clear handlers list

Declaration

void ClearHandlersList()

DeleteEventsHandler(string)

Delete events handler

Declaration

void DeleteEventsHandler(string Name)

Parameters

Type	Name	Description
string	Name	Event name

EndUpdate()

Declaration

void EndUpdate()

FindProperty(string)

Find property by Name

Declaration

IST_XMLPropPointer FindProperty(string Name)

Parameters

Type	Name	Description
string	Name	Property name

Returns

Type	Description
IST_XMLPropPointer

FindPropertyInWholeScope(string)

Find property in whole scope

Declaration

IST_XMLPropPointer FindPropertyInWholeScope(string Name)

Parameters

Type	Name	Description
string	Name	Property name

Returns

Type	Description
IST_XMLPropPointer

ForceCreateChildPropOfName(string)

Force create child property of specified name

Declaration

IST_XMLPropPointer ForceCreateChildPropOfName(string PropName)

Parameters

Type	Name	Description
string	PropName	Property name

Returns

Type	Description
IST_XMLPropPointer

GetAttributeAsBoolean(string, bool)

Declaration

bool GetAttributeAsBoolean(string Name, bool DefValue)

Parameters

Type	Name	Description
string	Name
bool	DefValue

Returns

Type	Description
bool

GetCopy()

Create a copy along with child elements

Declaration

IST_XMLPropPointer GetCopy()

Returns

Type	Description
IST_XMLPropPointer

GetEventsHandler(string)

Get events handler

Declaration

nint GetEventsHandler(string Name)

Parameters

Type	Name	Description
string	Name	Event name

Returns

Type	Description
nint

GetExpressionValueAsBoolean(string, bool)

Declaration

bool GetExpressionValueAsBoolean(string Expr, bool DefValue)

Parameters

Type	Name	Description
string	Expr
bool	DefValue

Returns

Type	Description
bool

GetExpressionValueAsFloat(string, double)

Declaration

double GetExpressionValueAsFloat(string Expr, double DefValue)

Parameters

Type	Name	Description
string	Expr
double	DefValue

Returns

Type	Description
double

GetExpressionValueAsString(string, string)

Get expression value as string

Declaration

string GetExpressionValueAsString(string Expr, string DefValue)

Parameters

Type	Name	Description
string	Expr	Expression
string	DefValue	Default value

Returns

Type	Description
string

GetFullName(bool)

Declaration

string GetFullName(bool RootNodeToo)

Parameters

Type	Name	Description
bool	RootNodeToo

Returns

Type	Description
string

HasArray(string)

Return true, if the property has a child array (IST_PropArray) named Name

Declaration

bool HasArray(string Name)

Parameters

Type	Name	Description
string	Name	Child array name

Returns

Type	Description
bool

IsArray()

Return true, if the property is an array (IST_PropArray)

Declaration

bool IsArray()

Returns

Type	Description
bool

IsAttributesSameWithDefaultValue()

Restore the default attributes

Declaration

bool IsAttributesSameWithDefaultValue()

Returns

Type	Description
bool

IsCaseNode()

Return true, if the property is a switchable complex type (IST_XMLPropCaseNode)

Declaration

bool IsCaseNode()

Returns

Type	Description
bool

IsEq(IST_XMLPropPointer, double, double)

Declaration

bool IsEq(IST_XMLPropPointer p, double LinearTol, double FloatTol)

Parameters

Type	Name	Description
IST_XMLPropPointer	p
double	LinearTol
double	FloatTol

Returns

Type	Description
bool

IsInheritFrom(string)

Is property type a descendant of type TypeName

Declaration

bool IsInheritFrom(string TypeName)

Parameters

Type	Name	Description
string	TypeName	Type name

Returns

Type	Description
bool

IsSameWithDefaultValue()

Declaration

bool IsSameWithDefaultValue()

Returns

Type	Description
bool

LoadFromDisplacedXMLFile(string, string, string)

Load from displaced XML file

Declaration

void LoadFromDisplacedXMLFile(string AFileName, string OriginalFolder, string OriginalType)

Parameters

Type	Name	Description
string	AFileName	XML file name
string	OriginalFolder	Original folder
string	OriginalType	Original type

LoadFromExistingXMLFile(string, string)

Load from existing XML file

Declaration

void LoadFromExistingXMLFile(string AFileName, string AnXMLNodePath)

Parameters

Type	Name	Description
string	AFileName	XML file name
string	AnXMLNodePath	XML node path

LoadFromSingleFileStream(IStream)

Load from single file stream

Declaration

void LoadFromSingleFileStream(IStream Stream)

Parameters

Type	Name	Description
IStream	Stream	Stream

LoadFromStream(IStream, bool)

Declaration

void LoadFromStream(IStream Stream, bool Compress)

Parameters

Type	Name	Description
IStream	Stream
bool	Compress

LoadFromXMLFile(string)

Load from XML file

Declaration

void LoadFromXMLFile(string AFileName)

Parameters

Type	Name	Description
string	AFileName	XML file name

LoadFromXMLText(string)

Load content of properites from the specified XML text string

Declaration

bool LoadFromXMLText(string XMLText)

Parameters

Type	Name	Description
string	XMLText

Returns

Type	Description
bool

RestoreDefaultValue()

Restore the default value

Declaration

void RestoreDefaultValue()

SaveMarkedToXMLFile(string)

Save marked to XML file

Declaration

void SaveMarkedToXMLFile(string AFileName)

Parameters

Type	Name	Description
string	AFileName	XML file name

SaveToDisplacedXMLFile(string, string)

Save to displaced XML file

Declaration

void SaveToDisplacedXMLFile(string AFileName, string OriginalFolder)

Parameters

Type	Name	Description
string	AFileName	XML file name
string	OriginalFolder	Original folder

SaveToExistingXMLFile(string, string)

Save to existing XML file

Declaration

void SaveToExistingXMLFile(string AFileName, string AnXMLNodePath)

Parameters

Type	Name	Description
string	AFileName	XML file name
string	AnXMLNodePath	XML node path

SaveToSingleFileStream(IStream)

Save to single file stream

Declaration

void SaveToSingleFileStream(IStream Stream)

Parameters

Type	Name	Description
IStream	Stream	Stream

SaveToStream(IStream, bool)

Declaration

void SaveToStream(IStream Stream, bool Compress)

Parameters

Type	Name	Description
IStream	Stream
bool	Compress

SaveToXMLFile(string)

Save to XML file

Declaration

void SaveToXMLFile(string AFileName)

Parameters

Type	Name	Description
string	AFileName	XML file name

SaveToXMLText()

Save content of properites to an XML text string

Declaration

string SaveToXMLText()

Returns

Type	Description
string