Class XMLPropPointerHelper

Helper methods for IST_XMLPropPointer

Inheritance

object

XMLPropPointerHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class XMLPropPointerHelper

Methods

AddEventsHandler(ComWrapper<IST_XMLPropPointer>, string, IST_AbstractPropEventsHandler)

Subscribe to XML property event tracking

Declaration

public static void AddEventsHandler(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, IST_AbstractPropEventsHandler Handler)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
IST_AbstractPropEventsHandler	Handler

Arr(ComWrapper<IST_XMLPropPointer>, string)

Retrieves the array property by name

Declaration

public static ComWrapper<IST_XMLPropArray> Arr(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
ComWrapper<IST_XMLPropArray>

Assign(ComWrapper<IST_XMLPropPointer>, IST_XMLPropPointer)

Copy data from another property

Declaration

public static void Assign(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IST_XMLPropPointer Src)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IST_XMLPropPointer	Src

AssignHandlers(ComWrapper<IST_XMLPropPointer>, IST_XMLPropPointer)

Copy event handlers from another similar property

Declaration

public static void AssignHandlers(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IST_XMLPropPointer Src)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IST_XMLPropPointer	Src

Attribute(ComWrapper<IST_XMLPropPointer>, string)

Gets the attribute value by name

Declaration

public static string Attribute(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
string

AttributeBol(ComWrapper<IST_XMLPropPointer>, string)

Checks if the attribute is a boolean

Declaration

public static bool AttributeBol(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

AttributeExists(ComWrapper<IST_XMLPropPointer>, string)

Checks if the attribute exists by name

Declaration

public static bool AttributeExists(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

AttributeFlt(ComWrapper<IST_XMLPropPointer>, string)

Gets the float attribute value by name

Declaration

public static double AttributeFlt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
double

AttributeInt(ComWrapper<IST_XMLPropPointer>, string)

Gets the integer attribute value by name

Declaration

public static int AttributeInt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
int

AttributeList(ComWrapper<IST_XMLPropPointer>)

Attributes list

Declaration

public static ComWrapper<IST_XMLPropAttributesList> AttributeList(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropAttributesList>

BeginUpdate(ComWrapper<IST_XMLPropPointer>)

Begins updating the property

Declaration

public static void BeginUpdate(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Bol(ComWrapper<IST_XMLPropPointer>, string)

Checks if the boolean property by name is true.

Declaration

public static bool Bol(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

CStr(ComWrapper<IST_XMLPropPointer>, string)

Gets the с string property value by name

Declaration

public static string CStr(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
string

Caption(ComWrapper<IST_XMLPropPointer>)

Property caption

Declaration

public static string Caption(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

Child(ComWrapper<IST_XMLPropPointer>)

Child property

Declaration

public static ComWrapper<IST_XMLPropPointer> Child(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

ClearHandlersList(ComWrapper<IST_XMLPropPointer>)

Clears the list of event handlers

Declaration

public static void ClearHandlersList(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

DataText(ComWrapper<IST_XMLPropPointer>)

XML representation of the property

Declaration

public static string DataText(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

DefaultValue(ComWrapper<IST_XMLPropPointer>)

Default property value

Declaration

public static string DefaultValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

DeleteEventsHandler(ComWrapper<IST_XMLPropPointer>, string)

Deletes an event handler by name

Declaration

public static void DeleteEventsHandler(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Descriptor(ComWrapper<IST_XMLPropPointer>)

Property descriptor

Declaration

public static ComWrapper<IST_XMLPropDescriptor> Descriptor(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropDescriptor>

EndUpdate(ComWrapper<IST_XMLPropPointer>)

Ends updating the property

Declaration

public static void EndUpdate(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

FindProperty(ComWrapper<IST_XMLPropPointer>, string)

Find property by Name

Declaration

public static ComWrapper<IST_XMLPropPointer> FindProperty(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

FindPropertyInWholeScope(ComWrapper<IST_XMLPropPointer>, string)

Find property in whole scope

Declaration

public static ComWrapper<IST_XMLPropPointer> FindPropertyInWholeScope(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

Flt(ComWrapper<IST_XMLPropPointer>, string)

Gets the float property value by name

Declaration

public static double Flt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
double

ForceCreateChildPropOfName(ComWrapper<IST_XMLPropPointer>, string)

Find property by Name

Declaration

public static ComWrapper<IST_XMLPropPointer> ForceCreateChildPropOfName(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string propName)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	propName

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

GetAttributeAsBoolean(ComWrapper<IST_XMLPropPointer>, string, bool)

Gets the boolean attribute value by name with a default value

Declaration

public static bool GetAttributeAsBoolean(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, bool DefValue)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
bool	DefValue

Returns

Type	Description
bool

GetCopy(ComWrapper<IST_XMLPropPointer>)

Create a copy along with child elements

Declaration

public static ComWrapper<IST_XMLPropPointer> GetCopy(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

GetEventsHandler(ComWrapper<IST_XMLPropPointer>, string)

Get events handler

Declaration

public static nint GetEventsHandler(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
IntPtr

GetExpressionValueAsBoolean(ComWrapper<IST_XMLPropPointer>, string, bool)

Gets the boolean expression value as boolean

Declaration

public static bool GetExpressionValueAsBoolean(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string Expr, bool DefValue)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	Expr
bool	DefValue

Returns

Type	Description
bool

GetExpressionValueAsFloat(ComWrapper<IST_XMLPropPointer>, string, double)

Gets the float expression value as float

Declaration

public static double GetExpressionValueAsFloat(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string Expr, double DefValue)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	Expr
double	DefValue

Returns

Type	Description
double

GetExpressionValueAsString(ComWrapper<IST_XMLPropPointer>, string, string)

Gets the string expression value as string

Declaration

public static string GetExpressionValueAsString(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string Expr, string DefValue)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	Expr
string	DefValue

Returns

Type	Description
string

GetFullName(ComWrapper<IST_XMLPropPointer>, bool)

Gets the full name of the property

Declaration

public static string GetFullName(this ComWrapper<IST_XMLPropPointer> XMLPropCom, bool RootNodeToo)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
bool	RootNodeToo

Returns

Type	Description
string

HasArray(ComWrapper<IST_XMLPropPointer>, string)

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

Declaration

public static bool HasArray(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

Int(ComWrapper<IST_XMLPropPointer>, string)

Gets the integer property value by name

Declaration

public static int Int(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
int

IsArray(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static bool IsArray(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsAttributesSameWithDefaultValue(ComWrapper<IST_XMLPropPointer>)

Restore the default attributes

Declaration

public static bool IsAttributesSameWithDefaultValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsCaseNode(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static bool IsCaseNode(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsComputed(ComWrapper<IST_XMLPropPointer>)

Is computed property

Declaration

public static bool IsComputed(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsEnabled(ComWrapper<IST_XMLPropPointer>)

Enabled state of the property

Declaration

public static bool IsEnabled(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsEq(ComWrapper<IST_XMLPropPointer>, IST_XMLPropPointer, double, double)

Restore the default attributes

Declaration

public static bool IsEq(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IST_XMLPropPointer p, double LinearTol, double FloatTol)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IST_XMLPropPointer	p
double	LinearTol
double	FloatTol

Returns

Type	Description
bool

IsInheritFrom(ComWrapper<IST_XMLPropPointer>, string)

Is property type a descendant of type TypeName

Declaration

public static bool IsInheritFrom(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string typename)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	typename

Returns

Type	Description
bool

IsObsolete(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static bool IsObsolete(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsReadOnly(ComWrapper<IST_XMLPropPointer>)

Is the property read-only

Declaration

public static bool IsReadOnly(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

IsSameWithDefaultValue(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static bool IsSameWithDefaultValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

LoadFromDisplacedXMLFile(ComWrapper<IST_XMLPropPointer>, string, string, string)

Load from displaced XML file

Declaration

public static void LoadFromDisplacedXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName, string OriginalFolder, string OriginalType)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName
string	OriginalFolder
string	OriginalType

LoadFromExistingXMLFile(ComWrapper<IST_XMLPropPointer>, string, string)

Load from existing XML file

Declaration

public static void LoadFromExistingXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName, string AnXMLNodePath)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName
string	AnXMLNodePath

LoadFromSingleFileStream(ComWrapper<IST_XMLPropPointer>, IStream)

Load from single file stream

Declaration

public static void LoadFromSingleFileStream(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IStream Stream)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IStream	Stream

LoadFromStream(ComWrapper<IST_XMLPropPointer>, IStream, bool)

Loads the property from a stream

Declaration

public static void LoadFromStream(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IStream Stream, bool Compress)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IStream	Stream
bool	Compress

LoadFromXMLFile(ComWrapper<IST_XMLPropPointer>, string)

Load from XML file

Declaration

public static void LoadFromXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName

LoadFromXMLText(ComWrapper<IST_XMLPropPointer>, string)

Load content of properites from the specified XML text string.

Declaration

public static bool LoadFromXMLText(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string XMLText)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	XMLText

Returns

Type	Description
bool

Name(ComWrapper<IST_XMLPropPointer>)

Property name

Declaration

public static string Name(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

NodeValue(ComWrapper<IST_XMLPropPointer>)

Property value as text

Declaration

public static string NodeValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

ParamType(ComWrapper<IST_XMLPropPointer>)

Property type

Declaration

public static string ParamType(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

Parent(ComWrapper<IST_XMLPropPointer>)

Parent property

Declaration

public static ComWrapper<IST_XMLPropPointer> Parent(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

PropEnabled(ComWrapper<IST_XMLPropPointer>, string)

Checks if the property is enabled by name

Declaration

public static bool PropEnabled(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

PropExists(ComWrapper<IST_XMLPropPointer>, string)

Checks if the property exists

Declaration

public static bool PropExists(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
bool

Ptr(ComWrapper<IST_XMLPropPointer>, string)

Gets the pointer property

Declaration

public static ComWrapper<IST_XMLPropPointer> Ptr(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

RawAttribute(ComWrapper<IST_XMLPropPointer>, string)

Gets the raw attribute value by name.

Declaration

public static string RawAttribute(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
string

RestoreDefaultValue(ComWrapper<IST_XMLPropPointer>)

Restore the default value

Declaration

public static void RestoreDefaultValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

SaveMarkedToXMLFile(ComWrapper<IST_XMLPropPointer>, string)

Save marked to XML file

Declaration

public static void SaveMarkedToXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName

SaveToDisplacedXMLFile(ComWrapper<IST_XMLPropPointer>, string, string)

Save to displaced XML file

Declaration

public static void SaveToDisplacedXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName, string OriginalFolder)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName
string	OriginalFolder

SaveToExistingXMLFile(ComWrapper<IST_XMLPropPointer>, string, string)

Save to existing XML file

Declaration

public static void SaveToExistingXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName, string AnXMLNodePath)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName
string	AnXMLNodePath

SaveToFileMark(ComWrapper<IST_XMLPropPointer>)

Get save to file mark

Declaration

public static bool SaveToFileMark(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

SaveToSingleFileStream(ComWrapper<IST_XMLPropPointer>, IStream)

Save to single file stream

Declaration

public static void SaveToSingleFileStream(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IStream Stream)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IStream	Stream

SaveToStream(ComWrapper<IST_XMLPropPointer>, IStream, bool)

Declaration

public static void SaveToStream(this ComWrapper<IST_XMLPropPointer> XMLPropCom, IStream Stream, bool Compress)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
IStream	Stream
bool	Compress

SaveToXMLFile(ComWrapper<IST_XMLPropPointer>, string)

Save to XML file

Declaration

public static void SaveToXMLFile(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string AFileName)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	AFileName

SaveToXMLText(ComWrapper<IST_XMLPropPointer>)

Save content of properites to an XML text string.

Declaration

public static string SaveToXMLText(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

SetAttribute(ComWrapper<IST_XMLPropPointer>, string, string)

Sets the attribute value by name

Declaration

public static void SetAttribute(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, string value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
string	value

SetAttributeBol(ComWrapper<IST_XMLPropPointer>, string, bool)

Sets the boolean attribute value by name

Declaration

public static void SetAttributeBol(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
bool	value

SetAttributeFlt(ComWrapper<IST_XMLPropPointer>, string, double)

Sets the float attribute value by name

Declaration

public static void SetAttributeFlt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, double value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
double	value

SetAttributeInt(ComWrapper<IST_XMLPropPointer>, string, int)

Sets the integer attribute value by name

Declaration

public static void SetAttributeInt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, int value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
int	value

SetBol(ComWrapper<IST_XMLPropPointer>, string, bool)

Sets the boolean property value by name

Declaration

public static void SetBol(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
bool	value

SetFlt(ComWrapper<IST_XMLPropPointer>, string, double)

Sets the float property value by name

Declaration

public static void SetFlt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, double value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
double	value

SetInt(ComWrapper<IST_XMLPropPointer>, string, int)

Sets the integer property value by name

Declaration

public static void SetInt(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, int value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
int	value

SetNodeValue(ComWrapper<IST_XMLPropPointer>, string)

Set property value as text

Declaration

public static void SetNodeValue(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	value

SetPropEnabled(ComWrapper<IST_XMLPropPointer>, string, bool)

Sets the enabled state of the property by name

Declaration

public static void SetPropEnabled(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
bool	value

SetRawAttribute(ComWrapper<IST_XMLPropPointer>, string, string)

Sets the raw attribute value by name

Declaration

public static void SetRawAttribute(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, string value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
string	value

SetSaveToFileMark(ComWrapper<IST_XMLPropPointer>, bool)

Set save to file mark

Declaration

public static void SetSaveToFileMark(this ComWrapper<IST_XMLPropPointer> XMLPropCom, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
bool	value

SetStr(ComWrapper<IST_XMLPropPointer>, string, string)

Sets the string property value by name

Declaration

public static void SetStr(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name, string value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name
string	value

SetUpdated(ComWrapper<IST_XMLPropPointer>, bool)

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

Declaration

public static void SetUpdated(this ComWrapper<IST_XMLPropPointer> XMLPropCom, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
bool	value

SetValueAsBoolean(ComWrapper<IST_XMLPropPointer>, bool)

Set the value of the corresponding type

Declaration

public static void SetValueAsBoolean(this ComWrapper<IST_XMLPropPointer> XMLPropCom, bool value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
bool	value

SetValueAsDouble(ComWrapper<IST_XMLPropPointer>, double)

Set value as double

Declaration

public static void SetValueAsDouble(this ComWrapper<IST_XMLPropPointer> XMLPropCom, double value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
double	value

SetValueAsInteger(ComWrapper<IST_XMLPropPointer>, int)

Set value as integer

Declaration

public static void SetValueAsInteger(this ComWrapper<IST_XMLPropPointer> XMLPropCom, int value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
int	value

SetValueAsString(ComWrapper<IST_XMLPropPointer>, string)

Set value as string

Declaration

public static void SetValueAsString(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	value

SetVersion(ComWrapper<IST_XMLPropPointer>, int)

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

Declaration

public static void SetVersion(this ComWrapper<IST_XMLPropPointer> XMLPropCom, int value)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
int	value

Sibling(ComWrapper<IST_XMLPropPointer>)

Sibling property

Declaration

public static ComWrapper<IST_XMLPropPointer> Sibling(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ComWrapper<IST_XMLPropPointer>

SimpleType(ComWrapper<IST_XMLPropPointer>)

Simple property type

Declaration

public static TSTSimplePropType SimpleType(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
TSTSimplePropType

Str(ComWrapper<IST_XMLPropPointer>, string)

Gets the string property value by name

Declaration

public static string Str(this ComWrapper<IST_XMLPropPointer> XMLPropCom, string name)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom
string	name

Returns

Type	Description
string

UpdateCount(ComWrapper<IST_XMLPropPointer>)

Number of pending BeginUpdate calls

Declaration

public static int UpdateCount(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
int

UpdateStamp(ComWrapper<IST_XMLPropPointer>)

Gets the update stamp of the property

Declaration

public static ulong UpdateStamp(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
ulong

Updated(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static bool Updated(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

ValueAsBoolean(ComWrapper<IST_XMLPropPointer>)

Get the value of the corresponding type

Declaration

public static bool ValueAsBoolean(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
bool

ValueAsCalculatedString(ComWrapper<IST_XMLPropPointer>)

Get value as calculated string

Declaration

public static string ValueAsCalculatedString(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

ValueAsDouble(ComWrapper<IST_XMLPropPointer>)

Get value as double

Declaration

public static double ValueAsDouble(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
double

ValueAsInteger(ComWrapper<IST_XMLPropPointer>)

Get value as integer

Declaration

public static int ValueAsInteger(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
int

ValueAsString(ComWrapper<IST_XMLPropPointer>)

Get value as string

Declaration

public static string ValueAsString(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
string

Version(ComWrapper<IST_XMLPropPointer>)

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

Declaration

public static int Version(this ComWrapper<IST_XMLPropPointer> XMLPropCom)

Parameters

Type	Name	Description
ComWrapper<IST_XMLPropPointer>	XMLPropCom

Returns

Type	Description
int