Interface IClassifications

Gives access to classifications.

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 10, 0, 0)]
public interface IClassifications

Remarks

This interface is available since v7.10.

Methods

CreateClass(DocumentId, String, String, String)

Creates a first level class entity in a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateClass(DocumentId inDocumentId, string inDescription, string inCode, string inComment)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to modify.
System.String	inDescription	Class description.
System.String	inCode	Class code, or empty string if none.
System.String	inComment	Class comment, or empty string if none.

Returns

Type	Description
ElementId	Identifier of the created class entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

The classification document must contain at least one level entity otherwise an exception is thrown.

This method is available since v7.10.

CreateLevel(DocumentId, String)

Creates a level entity in a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateLevel(DocumentId inDocumentId, string inDescription)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to modify.
System.String	inDescription	Level description.

Returns

Type	Description
ElementId	Identifier of the created level entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.

CreateSubclass(ElementId, String, String, String)

Creates a class entity as a subclass of a higher level class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateSubclass(ElementId inElementId, string inDescription, string inCode, string inComment)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the higher level class entity to modify.
System.String	inDescription	Class description.
System.String	inCode	Class code, or empty string if none.
System.String	inComment	Class comment, or empty string if none.

Returns

Type	Description
ElementId	Identifier of the created class entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

The classification document must contain enough level entities otherwise an exception is thrown.

This method is available since v7.10.

DeleteLevel(ElementId)

Deletes a level entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void DeleteLevel(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the level entity to delete.

Remarks

Level entities cannot be deleted using the usual Delete(ElementId) method, this method must be used instead.

The number of levels must always be at least equal to the classification depth as returned by FindClassificationDepth(DocumentId). An exception will be thrown when attemting to delete a level entity that would result in breaking that condition.

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.

FindClassificationDepth(DocumentId)

Finds the depth of the classification defined in a specified classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
int FindClassificationDepth(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to analyze.

Returns

Type	Description
System.Int32	Depth of the classification defined in a specified classification document, or 0 if there are no classes.

Remarks

The depth of a classification is defined by the maximum number of classes in a "class - subclass - ... - subclass" chain.

This method is available since v7.10.

GetClassCode(ElementId)

Gets the code of a specified class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
string GetClassCode(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the class entity to analyze.

Returns

Type	Description
System.String	Class code or empty if none.

Remarks

This method is available since v7.10.

GetClassErpId(ElementId)

Gets the ERP identifier of a specified class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
string GetClassErpId(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the class entity to analyze.

Returns

Type	Description
System.String	Class ERP identifier or empty if none.

Remarks

This method is available since v7.10.

GetClasses(DocumentId)

Gets the first level classes entities that are in the classes folder of a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
List<ElementId> GetClasses(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to analyze.

Returns

Type	Description
List<ElementId>	Classes entities found.

Remarks

This method is available since v7.10.

GetLevels(DocumentId)

Gets the level entities that are in the levels folder of a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
List<ElementId> GetLevels(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to analyze.

Returns

Type	Description
List<ElementId>	Level entities found.

Remarks

This method is available since v7.10.

GetMultipleClassifyingParameter(DocumentId)

Gets the multiple classifying parameter entity of a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetMultipleClassifyingParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the classification document to analyze.

Returns

Type	Description
ElementId	Identifier of the multiple classifying parameter entity found.

Remarks

The multiple classifying parameter is a Boolean parameter, its value may be obtained and modified using the GetBooleanValue(ElementId) and SetBooleanValue(ElementId, Boolean) methods.

This method is available since v7.10.

GetSubclasses(ElementId)

Gets the classes entities that are subclasses of a specified class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
List<ElementId> GetSubclasses(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the class entity to analyze.

Returns

Type	Description
List<ElementId>	Classes entities found as subclasses of the specified class entity.

Remarks

This method is available since v7.10.

IsClassification(DocumentId)

Tells whether a document is a classification document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
bool IsClassification(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Boolean	The document is a classification document.

Remarks

This method is available since v7.10.

SetClassCode(ElementId, String)

Sets the code of a specified class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void SetClassCode(ElementId inElementId, string inCode)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the class entity to modify.
System.String	inCode	Class code, or empty string if none.

Remarks

This method is available since v7.10.

SetClassErpId(ElementId, String)

Sets the ERP identifier of a specified class entity.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void SetClassErpId(ElementId inElementId, string inErpId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the class entity to modify.
System.String	inErpId	Class ERP identifier, or empty string if none.

Remarks

This method is available since v7.10.