CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiCustomAttributesManager

    Root object which manages work with custom attributes

    Namespace: CAMAPI.CustomAttributes
    Assembly: CAMAPI.CustomAttributes.dll
    Syntax
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("C9B2DB5E-36EC-4C9C-9D9A-2790E23F3FFF")]
    public interface ICamApiCustomAttributesManager

    Properties

    ApplicationLibraries

    The list of libraries attached to the application

    Declaration
    ICamApiCustomAttributesLibraryList ApplicationLibraries { get; }
    Property Value
    Type Description
    ICamApiCustomAttributesLibraryList

    AttributeTypesTree

    The tree of attributes created from all active libraries

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

    Classes

    The list of classes of attributes

    Declaration
    ICamApiCustomAttributeClassList Classes { get; }
    Property Value
    Type Description
    ICamApiCustomAttributeClassList

    Methods

    CreateArrayType()

    Create attribute of the ICamApiCustomAttributesArray type to place it inside library

    Declaration
    ICamApiCustomAttributesArray CreateArrayType()
    Returns
    Type Description
    ICamApiCustomAttributesArray

    CreateAttributeType(string)

    Create attribute of the given ClassName class to place it inside library

    Declaration
    ICamApiCustomAttribute CreateAttributeType(string ClassName)
    Parameters
    Type Name Description
    string ClassName
    Returns
    Type Description
    ICamApiCustomAttribute

    CreateBooleanType()

    Create attribute of the ICamApiBooleanCustomAttribute type to place it inside library

    Declaration
    ICamApiBooleanCustomAttribute CreateBooleanType()
    Returns
    Type Description
    ICamApiBooleanCustomAttribute

    CreateCategoryType()

    Create attribute of the ICamApiCustomAttributeCategory type to place it inside library

    Declaration
    ICamApiCustomAttributeCategory CreateCategoryType()
    Returns
    Type Description
    ICamApiCustomAttributeCategory

    CreateFloatType()

    Create attribute of the ICamApiFloatCustomAttribute type to place it inside library

    Declaration
    ICamApiFloatCustomAttribute CreateFloatType()
    Returns
    Type Description
    ICamApiFloatCustomAttribute

    CreateIntegerType()

    Create attribute of the ICamApiIntegerCustomAttribute type to place it inside library

    Declaration
    ICamApiIntegerCustomAttribute CreateIntegerType()
    Returns
    Type Description
    ICamApiIntegerCustomAttribute

    CreateNewLibrary()

    Create a new library file

    Declaration
    ICamApiCustomAttributesLibrary CreateNewLibrary()
    Returns
    Type Description
    ICamApiCustomAttributesLibrary

    CreateStringType()

    Create attribute of the ICamApiStringCustomAttribute type to place it inside library

    Declaration
    ICamApiStringCustomAttribute CreateStringType()
    Returns
    Type Description
    ICamApiStringCustomAttribute

    GetAttributesForObject(ICamApiObjectWithAttributes)

    Get list of attributes applicable for the object

    Declaration
    ICamApiCustomAttributesTree GetAttributesForObject(ICamApiObjectWithAttributes AnObject)
    Parameters
    Type Name Description
    ICamApiObjectWithAttributes AnObject
    Returns
    Type Description
    ICamApiCustomAttributesTree

    LoadExistingLibrary(string)

    Load existing library from file

    Declaration
    ICamApiCustomAttributesLibrary LoadExistingLibrary(string LibraryFileName)
    Parameters
    Type Name Description
    string LibraryFileName
    Returns
    Type Description
    ICamApiCustomAttributesLibrary

    MakeCopyOfLibrary(string, string)

    Creates a copy of library with SourceLibraryFileName and saves it to TargetLibraryFileName. Makes unique LibraryID for the new library and resets LibraryVersion

    Declaration
    ICamApiCustomAttributesLibrary MakeCopyOfLibrary(string SourceLibraryFileName, string TargetLibraryFileName)
    Parameters
    Type Name Description
    string SourceLibraryFileName
    string TargetLibraryFileName
    Returns
    Type Description
    ICamApiCustomAttributesLibrary

    SaveLibrary(ICamApiCustomAttributesLibrary, string)

    Save the library to file with specified name If the 'LibraryFileName' parameter is empty then the library will be saved to the 'Lib.FileName' file Returns true if success

    Declaration
    bool SaveLibrary(ICamApiCustomAttributesLibrary Lib, string LibraryFileName)
    Parameters
    Type Name Description
    ICamApiCustomAttributesLibrary Lib
    string LibraryFileName
    Returns
    Type Description
    bool
    In this article