Interface IFamilies
Gives access to families.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 7, 0, 0)]
public interface IFamiliesRemarks
This interface is available since v7.7.
Methods
AddCatalogColumn(DocumentId, ElementId)
Add a new column to a family document
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void AddCatalogColumn(DocumentId inDocumentId, ElementId inParameter)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inParameter | Parameter to use for the new column |
Remarks
This method is available since v7.18.
AddCatalogNewRow(DocumentId)
Add a new row to the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
ElementId AddCatalogNewRow(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to modify. |
Returns
| Type | Description |
|---|---|
| ElementId | Row identifier. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
AddExplicitInstance(DocumentId, String, DocumentId)
Adds an explicit instance to a family document catalog
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void AddExplicitInstance(DocumentId inDocumentId, string inCode, DocumentId instanceDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Family document |
| System.String | inCode | Code to add |
| DocumentId | instanceDocumentId | Document used as an instance |
CreateDerivedDocument(PdmObjectId, DocumentId, DocumentId)
Creates a new derived family document of a specified family document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId CreateDerivedDocument(PdmObjectId inOwnerId, DocumentId inDocumentId, DocumentId inGenericId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inOwnerId | Identifier of owner. |
| DocumentId | inDocumentId | Identifier of the family document to derive. |
| DocumentId | inGenericId | Identifier of the derived generic document, or Empty if not derived. |
Returns
| Type | Description |
|---|---|
| DocumentId | Derived family document identifier. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.10.
DeleteCatalogRow(ElementId)
Delete the row of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void DeleteCatalogRow(ElementId inRow)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row to delete. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
GetBaseDocument(DocumentId)
Gets the base family of a derived family.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId GetBaseDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the derived family document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Base family document identifier, or empty if the family is not derived. |
Remarks
This method is available since v7.10.
GetCatalogCellBooleanValue(ElementId, ElementId)
Gets the boolean value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
bool GetCatalogCellBooleanValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellCodeValue(ElementId, ElementId)
Gets the code value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
string GetCatalogCellCodeValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.String | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellColorValue(ElementId, ElementId)
Gets the color value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
Color GetCatalogCellColorValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| Color | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
GetCatalogCellEnumerationValue(ElementId, ElementId)
Gets the enumeration value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
int GetCatalogCellEnumerationValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellFamilyValue(ElementId, ElementId)
Gets the family value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
PdmMinorRevisionId GetCatalogCellFamilyValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| PdmMinorRevisionId | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellIntegerValue(ElementId, ElementId)
Gets the integer value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
int GetCatalogCellIntegerValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellRealValue(ElementId, ElementId)
Gets the real value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
double GetCatalogCellRealValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.Double | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellTextValue(ElementId, ElementId)
Gets the text value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
string GetCatalogCellTextValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.String | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogCellUserEnumerationValue(ElementId, ElementId)
Gets the user enumeration value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
int GetCatalogCellUserEnumerationValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Value of the cell. |
Remarks
This method is available since v7.15.
GetCatalogColumnParameters(DocumentId)
Gets the catalog column parameters.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
List<ElementId> GetCatalogColumnParameters(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Column parameter identifiers. |
Remarks
This method is available since v7.15.
GetCatalogRow(DocumentId, String)
Gets the catalog row.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
ElementId GetCatalogRow(DocumentId inDocumentId, string inCode)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
| System.String | inCode | The row code. |
Returns
| Type | Description |
|---|---|
| ElementId | Row identifier. |
Remarks
This method is available since v7.15.
GetCodes(DocumentId)
Gets the codes of a family document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<string> GetCodes(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
Returns
| Type | Description |
|---|---|
| List<System.String> | Codes found. |
Remarks
This method is available since v7.7.
GetCompleteConstraintData(ElementId)
Get the whole constraint data from a constraint entity
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
List<ConstraintDriverData> GetCompleteConstraintData(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the constraint entity. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ConstraintDriverData> | List of constraint data holding their children constraint data. |
Remarks
This method is available since v7.19.
GetConstrainedEntityCount(ElementId)
Get the number of entities constrained by a constraint entity
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
int GetConstrainedEntityCount(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the constraint entity. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The number of entities constrained |
Remarks
This method is available since v7.17.
GetDriverCondition(ElementId)
Gets condition on a driver, or null if no condition.
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
SmartBoolean GetDriverCondition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| SmartBoolean | Condition as Smartboolean. |
Remarks
This method is available since v7.19.
GetDriverFolderCondition(ElementId)
Gets condition on a driver folder, or null if no condition.
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
SmartBoolean GetDriverFolderCondition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| SmartBoolean | Condition as Smartboolean. |
Remarks
This method is available since v7.19.
GetDriversFolderImage(ElementId)
Gets the drivers folder image.
Declaration
[AvailableSinceVersion(7, 17, 0, 0)]
Bitmap GetDriversFolderImage(ElementId inDriverFolder)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inDriverFolder | Identifier of the drivers folder. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Bitmap | The driver image. |
Remarks
This method is available since v7.17.
GetGenericDocument(DocumentId)
Gets the generic document of a family.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId GetGenericDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Generic document identifier. |
Remarks
This method is available since v7.10.
GetOrderedConstrainedDrivers(ElementId)
Get the Driver entities constrained by a constraint entity
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
List<ElementId> GetOrderedConstrainedDrivers(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the constraint entity. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | List of driver entities by order of priority |
Remarks
This method is available since v7.19.
IsDerived(DocumentId)
Tells whether a family document is a derived family document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsDerived(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The family is a derived family. |
Remarks
This method is available since v7.10.
IsExplicit(DocumentId)
Tells whether a family document is an explicit family document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsExplicit(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The family is an explicit family. |
Remarks
This method is available since v7.10.
IsFamily(DocumentId)
Tells whether a document is a family document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
bool IsFamily(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The document is a family document. |
Remarks
This method is available since v7.7.
RemoveCatalogColumn(DocumentId, Int32)
Removes catalog column at a specified index.
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void RemoveCatalogColumn(DocumentId inDocumentId, int inColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inColumnIndex | Index of the column to remove. |
Remarks
This method is available since v7.18.
SetAsExplicit(DocumentId)
Sets family document as an explicit family document.
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void SetAsExplicit(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to use. |
Remarks
This method is available since v7.18.
SetCatalogCellBooleanValue(ElementId, ElementId, Boolean)
Sets the boolean value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellBooleanValue(ElementId inRow, ElementId inParameterId, bool inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.Boolean | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellCodeValue(ElementId, ElementId, String)
Sets the code value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellCodeValue(ElementId inRow, ElementId inParameterId, string inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.String | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellColorValue(ElementId, ElementId, Color)
Sets the color value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void SetCatalogCellColorValue(ElementId inRow, ElementId inParameterId, Color inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| Color | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
SetCatalogCellEnumerationValue(ElementId, ElementId, Int32)
Sets the enumeration value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellEnumerationValue(ElementId inRow, ElementId inParameterId, int inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.Int32 | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellFamilyValue(ElementId, ElementId, PdmMinorRevisionId)
Sets the family value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellFamilyValue(ElementId inRow, ElementId inParameterId, PdmMinorRevisionId inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| PdmMinorRevisionId | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellIntegerValue(ElementId, ElementId, Int32)
Sets the integer value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellIntegerValue(ElementId inRow, ElementId inParameterId, int inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.Int32 | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellRealValue(ElementId, ElementId, Double)
Sets the real value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellRealValue(ElementId inRow, ElementId inParameterId, double inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.Double | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellTextValue(ElementId, ElementId, String)
Sets the text value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellTextValue(ElementId inRow, ElementId inParameterId, string inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.String | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetCatalogCellUserEnumerationValue(ElementId, ElementId, Int32)
Sets the user enumeration value of the catalog cell.
Declaration
[AvailableSinceVersion(7, 15, 0, 60)]
void SetCatalogCellUserEnumerationValue(ElementId inRow, ElementId inParameterId, int inValue)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| System.Int32 | inValue | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.
SetDriversFolderImage(ElementId, String)
Sets the drivers folder image.
Declaration
[AvailableSinceVersion(7, 17, 0, 0)]
void SetDriversFolderImage(ElementId inDriverFolder, string inImagePath)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inDriverFolder | Identifier of the drivers folder. |
| System.String | inImagePath | Image of the driver. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
SetGenericDocument(DocumentId, DocumentId, DocumentId)
Sets the generic document of a family.
Declaration
[AvailableSinceVersion(7, 18, 400, 160)]
void SetGenericDocument(DocumentId inDocumentId, DocumentId inGenericDocumentId, DocumentId inFamilyBaseId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the family document to analyze. |
| DocumentId | inGenericDocumentId | Identifier of the document to use as Generic Document. |
| DocumentId | inFamilyBaseId | Identifier of the base family to use, or null if none.. |
Remarks
This method is available since v7.18.
SetInheritedCodes(DocumentId, List<String>)
Sets the inherited codes of a derived family.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void SetInheritedCodes(DocumentId inDocumentId, List<string> inCodes)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the derived family document to modify. |
| List<System.String> | inCodes | Base family codes to inherit in the derived family. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.