Interface ICADHost
Provides the interface that CAD add-ins have to implement to integrate the UOL SDK with the CAD Application for operations such as inserting CAD contents or updating CAD content properties.
Namespace: UOL.SDK
Assembly: UOL.SDK.dll
Syntax
public interface ICADHost
Methods
InsertCadContent(String, String, IEnumerable<CADProperty>, Boolean, CADMetadata)
Insert new content in the CAD file.
Declaration
CADHostResult InsertCadContent(string contentPath, string name, IEnumerable<CADProperty> properties, bool placeInstance, CADMetadata cadMetadata)
Parameters
Type | Name | Description |
---|---|---|
System.String | contentPath | The path to the content file to insert. |
System.String | name | The name of the CAD element that is inserted in CAD. |
System.Collections.Generic.IEnumerable<UOL.Models.CADProperty> | properties | The properties to inject into the CAD element. |
System.Boolean | placeInstance | A value indicating whether to place an instance of the newly loaded content. |
UOL.Models.CADMetadata | cadMetadata | The UOL.Models.CADMetadata for a single CAD file. |
Returns
Type | Description |
---|---|
CADHostResult | A CADHostResult that indicates if the method succeeded and it returns the active CAD object. |
SetPropertyValue(Object, String, Object)
Sets the property value
for the specified cadObject
.
Declaration
CADHostResult SetPropertyValue(object cadObject, string propertyName, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | cadObject | The CAD object to set properties for. |
System.String | propertyName | The name of the property to set. |
System.Object | value | The value to set. |
Returns
Type | Description |
---|---|
CADHostResult | A CADHostResult that indicates if the method succeeded and it returns the active CAD object. |
WriteAdditionalData(Object, String)
Writes additional data to the cadObject
.
Declaration
CADHostResult WriteAdditionalData(object cadObject, string data)
Parameters
Type | Name | Description |
---|---|---|
System.Object | cadObject | The CAD object to write additional data to. |
System.String | data | The additional data to write to the |
Returns
Type | Description |
---|---|
CADHostResult | A CADHostResult that indicates if the method succeeded and it returns the active CAD object. |