CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface IST_XMLPropCaseNode

    Complex XML type with switchable child properties

    Namespace: STXMLPropTypes
    Assembly: STXMLPropTypes.dll
    Syntax
    [Guid("0C494748-E2DE-45B5-80CE-186031E9BCDB")]
    public interface IST_XMLPropCaseNode : IST_XMLPropPointer

    Properties

    ActiveChild

    The active child element object

    Declaration
    IST_XMLPropPointer ActiveChild { get; }
    Property Value
    Type Description
    IST_XMLPropPointer

    ActiveChildIndex

    The active child element index in the PossibleTypes list

    Declaration
    int ActiveChildIndex { get; set; }
    Property Value
    Type Description
    int

    ActiveChildType

    The active child element type

    Declaration
    string ActiveChildType { get; set; }
    Property Value
    Type Description
    string

    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

    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

    Declaration
    string Caption { get; }
    Property Value
    Type Description
    string

    Child

    Declaration
    IST_XMLPropPointer Child { get; }
    Property Value
    Type Description
    IST_XMLPropPointer

    DataText

    Declaration
    string DataText { get; }
    Property Value
    Type Description
    string

    DefaultValue

    Declaration
    string DefaultValue { get; }
    Property Value
    Type Description
    string

    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

    Declaration
    bool IsComputed { get; }
    Property Value
    Type Description
    bool

    IsEnabled

    Declaration
    bool IsEnabled { get; set; }
    Property Value
    Type Description
    bool

    IsObsolete

    Declaration
    bool IsObsolete { get; }
    Property Value
    Type Description
    bool

    IsReadOnly

    Declaration
    bool IsReadOnly { get; }
    Property Value
    Type Description
    bool

    Name

    Declaration
    string Name { get; }
    Property Value
    Type Description
    string

    NodeValue

    Declaration
    string NodeValue { get; set; }
    Property Value
    Type Description
    string

    ParamType

    Declaration
    string ParamType { get; }
    Property Value
    Type Description
    string

    Parent

    Declaration
    IST_XMLPropPointer Parent { get; }
    Property Value
    Type Description
    IST_XMLPropPointer

    PossibleChildren

    The list of the possible child elements that are at least once were selected

    Declaration
    IST_XMLPropArray PossibleChildren { get; }
    Property Value
    Type Description
    IST_XMLPropArray

    PossibleTypes[int]

    Declaration
    IST_XMLPropDescriptor PossibleTypes[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    IST_XMLPropDescriptor

    PossibleTypesCount

    The number of possible types of child elements

    Declaration
    int PossibleTypesCount { get; }
    Property Value
    Type Description
    int

    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

    Declaration
    bool SaveToFileMark { get; set; }
    Property Value
    Type Description
    bool

    Sibling

    Declaration
    IST_XMLPropPointer Sibling { get; }
    Property Value
    Type Description
    IST_XMLPropPointer

    SimpleType

    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

    Declaration
    int UpdateCount { get; }
    Property Value
    Type Description
    int

    UpdateStamp

    Declaration
    ulong UpdateStamp { get; }
    Property Value
    Type Description
    ulong

    Updated

    Declaration
    bool Updated { get; set; }
    Property Value
    Type Description
    bool

    ValueAsBoolean

    Declaration
    bool ValueAsBoolean { get; set; }
    Property Value
    Type Description
    bool

    ValueAsCalculatedString

    Declaration
    string ValueAsCalculatedString { get; }
    Property Value
    Type Description
    string

    ValueAsDouble

    Declaration
    double ValueAsDouble { get; set; }
    Property Value
    Type Description
    double

    ValueAsInteger

    Declaration
    int ValueAsInteger { get; set; }
    Property Value
    Type Description
    int

    ValueAsString

    Declaration
    string ValueAsString { get; set; }
    Property Value
    Type Description
    string

    Version

    Declaration
    int Version { get; set; }
    Property Value
    Type Description
    int

    Methods

    AddEventsHandler(string, IST_AbstractPropEventsHandler)

    Declaration
    void AddEventsHandler(string Name, IST_AbstractPropEventsHandler Handler)
    Parameters
    Type Name Description
    string Name
    IST_AbstractPropEventsHandler Handler

    Assign(IST_XMLPropPointer)

    Declaration
    void Assign(IST_XMLPropPointer Src)
    Parameters
    Type Name Description
    IST_XMLPropPointer Src

    AssignHandlers(IST_XMLPropPointer)

    Declaration
    void AssignHandlers(IST_XMLPropPointer Src)
    Parameters
    Type Name Description
    IST_XMLPropPointer Src

    BeginUpdate()

    Declaration
    void BeginUpdate()

    ClearHandlersList()

    Declaration
    void ClearHandlersList()

    DeleteEventsHandler(string)

    Declaration
    void DeleteEventsHandler(string Name)
    Parameters
    Type Name Description
    string Name

    EndUpdate()

    Declaration
    void EndUpdate()

    FindProperty(string)

    Declaration
    IST_XMLPropPointer FindProperty(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    IST_XMLPropPointer

    FindPropertyInWholeScope(string)

    Declaration
    IST_XMLPropPointer FindPropertyInWholeScope(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    IST_XMLPropPointer

    ForceCreateChildPropOfName(string)

    Declaration
    IST_XMLPropPointer ForceCreateChildPropOfName(string PropName)
    Parameters
    Type Name Description
    string PropName
    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()

    Declaration
    IST_XMLPropPointer GetCopy()
    Returns
    Type Description
    IST_XMLPropPointer

    GetEventsHandler(string)

    Declaration
    nint GetEventsHandler(string Name)
    Parameters
    Type Name Description
    string 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)

    Declaration
    string GetExpressionValueAsString(string Expr, string DefValue)
    Parameters
    Type Name Description
    string Expr
    string DefValue
    Returns
    Type Description
    string

    GetFullName(bool)

    Declaration
    string GetFullName(bool RootNodeToo)
    Parameters
    Type Name Description
    bool RootNodeToo
    Returns
    Type Description
    string

    HasArray(string)

    Declaration
    bool HasArray(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    bool

    IndexOfPossibleChild(string)

    Find a list PossibleChildren element with type TypeName

    Declaration
    int IndexOfPossibleChild(string TypeName)
    Parameters
    Type Name Description
    string TypeName
    Returns
    Type Description
    int

    IsArray()

    Declaration
    bool IsArray()
    Returns
    Type Description
    bool

    IsAttributesSameWithDefaultValue()

    Declaration
    bool IsAttributesSameWithDefaultValue()
    Returns
    Type Description
    bool

    IsCaseNode()

    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)

    Declaration
    bool IsInheritFrom(string TypeName)
    Parameters
    Type Name Description
    string TypeName
    Returns
    Type Description
    bool

    IsSameWithDefaultValue()

    Declaration
    bool IsSameWithDefaultValue()
    Returns
    Type Description
    bool

    LoadFromDisplacedXMLFile(string, string, string)

    Declaration
    void LoadFromDisplacedXMLFile(string AFileName, string OriginalFolder, string OriginalType)
    Parameters
    Type Name Description
    string AFileName
    string OriginalFolder
    string OriginalType

    LoadFromExistingXMLFile(string, string)

    Declaration
    void LoadFromExistingXMLFile(string AFileName, string AnXMLNodePath)
    Parameters
    Type Name Description
    string AFileName
    string AnXMLNodePath

    LoadFromSingleFileStream(IStream)

    Declaration
    void LoadFromSingleFileStream(IStream Stream)
    Parameters
    Type Name Description
    IStream Stream

    LoadFromStream(IStream, bool)

    Declaration
    void LoadFromStream(IStream Stream, bool Compress)
    Parameters
    Type Name Description
    IStream Stream
    bool Compress

    LoadFromXMLFile(string)

    Declaration
    void LoadFromXMLFile(string AFileName)
    Parameters
    Type Name Description
    string AFileName

    LoadFromXMLText(string)

    Declaration
    bool LoadFromXMLText(string XMLText)
    Parameters
    Type Name Description
    string XMLText
    Returns
    Type Description
    bool

    ResetPossible()

    Declaration
    void ResetPossible()

    RestoreDefaultValue()

    Declaration
    void RestoreDefaultValue()

    SaveMarkedToXMLFile(string)

    Declaration
    void SaveMarkedToXMLFile(string AFileName)
    Parameters
    Type Name Description
    string AFileName

    SaveToDisplacedXMLFile(string, string)

    Declaration
    void SaveToDisplacedXMLFile(string AFileName, string OriginalFolder)
    Parameters
    Type Name Description
    string AFileName
    string OriginalFolder

    SaveToExistingXMLFile(string, string)

    Declaration
    void SaveToExistingXMLFile(string AFileName, string AnXMLNodePath)
    Parameters
    Type Name Description
    string AFileName
    string AnXMLNodePath

    SaveToSingleFileStream(IStream)

    Declaration
    void SaveToSingleFileStream(IStream Stream)
    Parameters
    Type Name Description
    IStream Stream

    SaveToStream(IStream, bool)

    Declaration
    void SaveToStream(IStream Stream, bool Compress)
    Parameters
    Type Name Description
    IStream Stream
    bool Compress

    SaveToXMLFile(string)

    Declaration
    void SaveToXMLFile(string AFileName)
    Parameters
    Type Name Description
    string AFileName

    SaveToXMLText()

    Declaration
    string SaveToXMLText()
    Returns
    Type Description
    string
    In this article