Class CustomAttributesManagerHelper

Helper methods for ICamApiCustomAttributesManager

Inheritance

object

CustomAttributesManagerHelper

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 CustomAttributesManagerHelper

Methods

ApplicationLibraries(ComWrapper<ICamApiCustomAttributesManager>)

The list of libraries attached to the application.

Declaration

public static ComWrapper<ICamApiCustomAttributesLibraryList> ApplicationLibraries(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesLibraryList>

AttributeTypesTree(ComWrapper<ICamApiCustomAttributesManager>)

The tree of attributes created from all active libraries.

Declaration

public static ComWrapper<ICamApiCustomAttributesTree> AttributeTypesTree(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTree>

Classes(ComWrapper<ICamApiCustomAttributesManager>)

The list of classes of attributes.

Declaration

public static ComWrapper<ICamApiCustomAttributeClassList> Classes(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributeClassList>

CreateArrayType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiCustomAttributesArray type to place it inside library.

Declaration

public static ComWrapper<ICamApiCustomAttributesArray> CreateArrayType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesArray>

CreateAttributeType(ComWrapper<ICamApiCustomAttributesManager>, string)

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

Declaration

public static ComWrapper<ICamApiCustomAttribute> CreateAttributeType(this ComWrapper<ICamApiCustomAttributesManager> mngr, string className)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr
string	className

Returns

Type	Description
ComWrapper<ICamApiCustomAttribute>

CreateBooleanType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiBooleanCustomAttribute type to place it inside library.

Declaration

public static ComWrapper<ICamApiBooleanCustomAttribute> CreateBooleanType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiBooleanCustomAttribute>

CreateCategoryType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiCustomAttributeCategory type to place it inside library.

Declaration

public static ComWrapper<ICamApiCustomAttributeCategory> CreateCategoryType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributeCategory>

CreateFloatType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiFloatCustomAttribute type to place it inside library.

Declaration

public static ComWrapper<ICamApiFloatCustomAttribute> CreateFloatType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiFloatCustomAttribute>

CreateIntegerType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiIntegerCustomAttribute type to place it inside library.

Declaration

public static ComWrapper<ICamApiIntegerCustomAttribute> CreateIntegerType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiIntegerCustomAttribute>

CreateNewLibrary(ComWrapper<ICamApiCustomAttributesManager>)

Create a new library file.

Declaration

public static ComWrapper<ICamApiCustomAttributesLibrary> CreateNewLibrary(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesLibrary>

CreateStringType(ComWrapper<ICamApiCustomAttributesManager>)

Create attribute of the ICamApiStringCustomAttribute type to place it inside library.

Declaration

public static ComWrapper<ICamApiStringCustomAttribute> CreateStringType(this ComWrapper<ICamApiCustomAttributesManager> mngr)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr

Returns

Type	Description
ComWrapper<ICamApiStringCustomAttribute>

GetAttributesForObject(ComWrapper<ICamApiCustomAttributesManager>, ICamApiObjectWithAttributes)

Get list of attributes applicable for the object.

Declaration

public static ComWrapper<ICamApiCustomAttributesTree> GetAttributesForObject(this ComWrapper<ICamApiCustomAttributesManager> mngr, ICamApiObjectWithAttributes anObject)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr
ICamApiObjectWithAttributes	anObject

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesTree>

LoadExistingLibrary(ComWrapper<ICamApiCustomAttributesManager>, string)

Load existing library from file.

Declaration

public static ComWrapper<ICamApiCustomAttributesLibrary> LoadExistingLibrary(this ComWrapper<ICamApiCustomAttributesManager> mngr, string libraryFileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr
string	libraryFileName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesLibrary>

MakeCopyOfLibrary(ComWrapper<ICamApiCustomAttributesManager>, 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

public static ComWrapper<ICamApiCustomAttributesLibrary> MakeCopyOfLibrary(this ComWrapper<ICamApiCustomAttributesManager> mngr, string sourceLibraryFileName, string targetLibraryFileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr
string	sourceLibraryFileName
string	targetLibraryFileName

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesLibrary>

SaveLibrary(ComWrapper<ICamApiCustomAttributesManager>, 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

public static bool SaveLibrary(this ComWrapper<ICamApiCustomAttributesManager> mngr, ICamApiCustomAttributesLibrary lib, string libraryFileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiCustomAttributesManager>	mngr
ICamApiCustomAttributesLibrary	lib
string	libraryFileName

Returns

Type	Description
bool