CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiCustomAttributesTreeNode

    Custom attributes tree node.

    Namespace: CAMAPI.CustomAttributes
    Assembly: CAMAPI.CustomAttributes.dll
    Syntax
    [Guid("A4036FC3-D90F-4B95-93D9-7E6228381296")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiCustomAttributesTreeNode

    Properties

    Arr

    Get child node as Array by its full name (divided by dots).

    Declaration
    ICamApiCustomAttributesArrayValueIndexer Arr { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesArrayValueIndexer

    AsArray

    Cast of this node to array if its type is array exactly, otherwise null.

    Declaration
    ICamApiCustomAttributesTreeNodesArray AsArray { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesTreeNodesArray

    Attribute

    Attribute of the node.

    Declaration
    ICamApiCustomAttribute Attribute { get; }
    Property Value
    Type Description
    ICamApiCustomAttribute

    Bol

    Get or set child node value as Boolean by its full name (divided by dots).

    Declaration
    ICamApiCustomAttributesBooleanValueIndexer Bol { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesBooleanValueIndexer

    Child

    First child node for this node.

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

    Flt

    Get or set child node value as Floating point number by its full name (divided by dots).

    Declaration
    ICamApiCustomAttributesFloatValueIndexer Flt { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesFloatValueIndexer

    FullName

    Full name of the node inside tree divided by dots.

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

    InstanceID

    Unique identifier of the attribute in the object's attributes collection.

    Declaration
    Guid InstanceID { get; }
    Property Value
    Type Description
    Guid

    Int

    Get or set child node value as Integer by its full name (divided by dots).

    Declaration
    ICamApiCustomAttributesIntegerValueIndexer Int { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesIntegerValueIndexer

    IsUndefined

    The value is True only if the attribute is not defined in any of the libraries connected to the application, but it was not explicitly created as untyped.

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

    IsUntyped

    The value is True only if the attribute is explicitly created as untyped (without declaration in any library).

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

    Name

    Name of attribute inside the node.

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

    NodeID

    Unique ID of node.

    Declaration
    Guid NodeID { get; }
    Property Value
    Type Description
    Guid

    Parent

    Parent node for this node.

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

    Sibling

    Next sibling node for this node.

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

    Str

    Get or set child node value as String by its full name (divided by dots).

    Declaration
    ICamApiCustomAttributesStringValueIndexer Str { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesStringValueIndexer

    Tree

    Owning tree of the node.

    Declaration
    ICamApiCustomAttributesTree Tree { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesTree

    TypeID

    Unique identifier of the attribute in a library of attributes.

    Declaration
    Guid TypeID { get; }
    Property Value
    Type Description
    Guid

    ValueAsBoolean

    Value of the attribute as boolean if it has value.

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

    ValueAsDouble

    Value of the attribute as floating point number if it has value.

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

    ValueAsInteger

    Value of the attribute as integer number if it has value.

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

    ValueAsString

    Value of the attribute as string if it has value.

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

    ValueType

    Type of value the attribute has.

    Declaration
    TCustomAttributeValueType ValueType { get; }
    Property Value
    Type Description
    TCustomAttributeValueType

    Methods

    CreateUntypedArrayChild(string)

    Creates child instance array attribute that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiCustomAttributesArray CreateUntypedArrayChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiCustomAttributesArray

    CreateUntypedBooleanChild(string)

    Creates child instance attribute with boolean value that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiBooleanCustomAttribute CreateUntypedBooleanChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiBooleanCustomAttribute

    CreateUntypedCategoryChild(string)

    Creates child instance category attribute that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiCustomAttributeCategory CreateUntypedCategoryChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiCustomAttributeCategory

    CreateUntypedChild(string, string)

    Creates child instance attribute that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiCustomAttribute CreateUntypedChild(string ClassName, string AttributeName)
    Parameters
    Type Name Description
    string ClassName
    string AttributeName
    Returns
    Type Description
    ICamApiCustomAttribute

    CreateUntypedFloatChild(string)

    Creates child instance attribute with floating number value that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiFloatCustomAttribute CreateUntypedFloatChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiFloatCustomAttribute

    CreateUntypedIntegerChild(string)

    Creates child instance attribute with integer number value that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiIntegerCustomAttribute CreateUntypedIntegerChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiIntegerCustomAttribute

    CreateUntypedStringChild(string)

    Creates child instance attribute with string value that does not have any corresponding type attribute in the libraries.

    Declaration
    ICamApiStringCustomAttribute CreateUntypedStringChild(string AttributeName)
    Parameters
    Type Name Description
    string AttributeName
    Returns
    Type Description
    ICamApiStringCustomAttribute

    FindChild(string)

    Find child node by its full name in tree of nodes (divided by dots).

    Declaration
    ICamApiCustomAttributesTreeNode FindChild(string FullName)
    Parameters
    Type Name Description
    string FullName
    Returns
    Type Description
    ICamApiCustomAttributesTreeNode

    FindChildByInstanceID(Guid, bool)

    Declaration
    ICamApiCustomAttributesTreeNode FindChildByInstanceID(Guid InstanceID, bool Deep)
    Parameters
    Type Name Description
    Guid InstanceID
    bool Deep
    Returns
    Type Description
    ICamApiCustomAttributesTreeNode

    FindChildByTypeID(Guid, bool)

    Declaration
    ICamApiCustomAttributesTreeNode FindChildByTypeID(Guid TypeID, bool Deep)
    Parameters
    Type Name Description
    Guid TypeID
    bool Deep
    Returns
    Type Description
    ICamApiCustomAttributesTreeNode

    HasChild(string)

    Returns true only if there is a child node with specified full name in tree of nodes (divided by dots).

    Declaration
    bool HasChild(string FullName)
    Parameters
    Type Name Description
    string FullName
    Returns
    Type Description
    bool
    In this article