Class PropertyShim

Static class to manipulate iproperties for a provided Document object.

Inheritance
System.Object
PropertyShim
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: InventorShims
Assembly: InventorShims.dll
Syntax
public static class PropertyShim

Methods

| Improve this Doc View Source

GetProperty(AssemblyDocument, String)

Return the property of a the specified Property within a AssemblyDocument object. Uses a short-form signature.

Declaration
public static Property GetProperty(this AssemblyDocument document, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document
System.String propertyName
Returns
Type Description
Inventor.Property
| Improve this Doc View Source

GetProperty(AssemblyDocument, String, String)

Returns the specified Property object in a AssemblyDocument if one exists. If none exists, null is returned.

Declaration
public static Property GetProperty(this AssemblyDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String setName

Property Set Name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Property
| Improve this Doc View Source

GetProperty(Document, String)

Return the property of a the specified Property within a Document object. Uses a short-form signature.

Declaration
public static Property GetProperty(this Document document, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Object
| Improve this Doc View Source

GetProperty(Document, String, String)

Returns the specified Property object in a Document if one exists. If none exists, null is returned.

Declaration
public static Property GetProperty(this Document document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String setName

Property Set Name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Property
| Improve this Doc View Source

GetProperty(DrawingDocument, String)

Return the property of a the specified Property within a DrawingDocument object. Uses a short-form signature.

Declaration
public static Property GetProperty(this DrawingDocument document, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document
System.String propertyName
Returns
Type Description
Inventor.Property
| Improve this Doc View Source

GetProperty(DrawingDocument, String, String)

Returns the specified Property object in a DrawingDocument if one exists. If none exists, null is returned.

Declaration
public static Property GetProperty(this DrawingDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String setName

Property Set Name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Property
| Improve this Doc View Source

GetProperty(PartDocument, String)

Return the property of a the specified Property within a PartDocument object. Uses a short-form signature.

Declaration
public static Property GetProperty(this PartDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document
System.String propertyName
Returns
Type Description
Inventor.Property
| Improve this Doc View Source

GetProperty(PartDocument, String, String)

Returns the specified Property object in a PartDocument if one exists. If none exists, null is returned.

Declaration
public static Property GetProperty(this PartDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String setName

Property Set Name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Property
| Improve this Doc View Source

GetProperty(PresentationDocument, String)

Return the property of a the specified Property within a PresentationDocument object. Uses a short-form signature.

Declaration
public static Property GetProperty(this PresentationDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document
System.String propertyName
Returns
Type Description
Inventor.Property
| Improve this Doc View Source

GetProperty(PresentationDocument, String, String)

Returns the specified Property object in a PresentationDocument if one exists. If none exists, null is returned.

Declaration
public static Property GetProperty(this PresentationDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String setName

Property Set Name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
Inventor.Property

Property
| Improve this Doc View Source

GetPropertyValue(AssemblyDocument, String)

Returns the iProperty Value for a provided AssemblyDocument and propertyName. Short signature.

Declaration
public static object GetPropertyValue(this AssemblyDocument document, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(AssemblyDocument, String, String)

Return the property value of a the specified Property within an AssemblyDocument object. Uses a long-form signature, specifying the Property Set.

Declaration
public static object GetPropertyValue(this AssemblyDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document
System.String setName
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(Document, String)

Returns the iProperty Value for a provided document and propertyName. Short signature.

Declaration
public static object GetPropertyValue(this Document document, string propertyName)
Parameters
Type Name Description
Inventor.Document document
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(Document, String, String)

Return the property value of a the specified Property within a Document object. Uses a long-form signature, specifying the Property Set.

Declaration
public static object GetPropertyValue(this Document document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String setName

Property Set name as a string.
System.String propertyName

Property Name as a string.
Returns
Type Description
System.Object

Object
| Improve this Doc View Source

GetPropertyValue(DrawingDocument, String)

Returns the iProperty Value for a provided DrawingDocument and propertyName. Short signature.

Declaration
public static object GetPropertyValue(this DrawingDocument document, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(DrawingDocument, String, String)

Return the property value of a the specified Property within a DrawingDocument object. Uses a long-form signature, specifying the Property Set.

Declaration
public static object GetPropertyValue(this DrawingDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document
System.String setName
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(PartDocument, String)

Returns the iProperty Value for a provided PartDocument and propertyName. Short signature.

Declaration
public static object GetPropertyValue(this PartDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(PartDocument, String, String)

Return the property value of a the specified Property within a PartDocument object. Uses a long-form signature, specifying the Property Set.

Declaration
public static object GetPropertyValue(this PartDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document
System.String setName
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(PresentationDocument, String)

Returns the iProperty Value for a provided PresentationDocument and propertyName. Short signature.

Declaration
public static object GetPropertyValue(this PresentationDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

GetPropertyValue(PresentationDocument, String, String)

Return the property value of a the specified Property within a PresentationDocument object. Uses a long-form signature, specifying the Property Set.

Declaration
public static object GetPropertyValue(this PresentationDocument document, string setName, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document
System.String setName
System.String propertyName
Returns
Type Description
System.Object
| Improve this Doc View Source

IsPropertyNative(String)

A simple static function that returns true if the specified property is one of Inventor's built-in iProperties.

Declaration
public static bool IsPropertyNative(string name)
Parameters
Type Name Description
System.String name

Property Name as a string.
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(AssemblyDocument, String)

A simple function that returns true/false if the specified property exists in the AssemblyDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this AssemblyDocument document, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(AssemblyDocument, String, String)

A simple function that returns true/false if the specified property exists in the AssemblyDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this AssemblyDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(Document, String)

A simple function that returns true/false if the specified property exists in the Document. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this Document document, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(Document, String, String)

A simple function that returns true/false if the specified property exists in the Document. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this Document document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(DrawingDocument, String)

A simple function that returns true/false if the specified property exists in the DrawingDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this DrawingDocument document, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(DrawingDocument, String, String)

A simple function that returns true/false if the specified property exists in the DrawingDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this DrawingDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(PartDocument, String)

A simple function that returns true/false if the specified property exists in the PartDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this PartDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(PartDocument, String, String)

A simple function that returns true/false if the specified property exists in the PartDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this PartDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(PresentationDocument, String)

A simple function that returns true/false if the specified property exists in the PresentationDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this PresentationDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

PropertyExists(PresentationDocument, String, String)

A simple function that returns true/false if the specified property exists in the PresentationDocument. This is the short-form signature of this function.

Declaration
public static bool PropertyExists(this PresentationDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
Returns
Type Description
System.Boolean

Boolean
| Improve this Doc View Source

RemoveProperty(AssemblyDocument, String)

Removes the specified AssemblyDocument property. If the property is native, it will only delete the iproperty's value. This is the short-form signature version of this method.

Declaration
public static void RemoveProperty(this AssemblyDocument document, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(AssemblyDocument, String, String)

Removes the specified AssemblyDocument property. If the property is native, it will only delete the iproperty's value. This is the long-form signature version of this method.

Declaration
public static void RemoveProperty(this AssemblyDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(Document, String)

Removes the specified document property. If the property is native, it will only delete the iproperty's value. This is the short-form signature version of this method.

Declaration
public static void RemoveProperty(this Document document, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(Document, String, String)

Removes the specified Document property. If the property is native, it will only delete the iproperty's value. This is the long-form signature version of this method.

Declaration
public static void RemoveProperty(this Document document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(DrawingDocument, String)

Removes the specified DrawingDocument property. If the property is native, it will only delete the iproperty's value. This is the short-form signature version of this method.

Declaration
public static void RemoveProperty(this DrawingDocument document, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(DrawingDocument, String, String)

Removes the specified DrawingDocument property. If the property is native, it will only delete the iproperty's value. This is the long-form signature version of this method.

Declaration
public static void RemoveProperty(this DrawingDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(PartDocument, String)

Removes the specified PartDocument property. If the property is native, it will only delete the iproperty's value. This is the short-form signature version of this method.

Declaration
public static void RemoveProperty(this PartDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(PartDocument, String, String)

Removes the specified PartDocument property. If the property is native, it will only delete the iproperty's value. This is the long-form signature version of this method.

Declaration
public static void RemoveProperty(this PartDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(PresentationDocument, String)

Removes the specified PresentationDocument property. If the property is native, it will only delete the iproperty's value. This is the short-form signature version of this method.

Declaration
public static void RemoveProperty(this PresentationDocument document, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertyName

Property Name as a string
| Improve this Doc View Source

RemoveProperty(PresentationDocument, String, String)

Removes the specified PresentationDocument property. If the property is native, it will only delete the iproperty's value. This is the long-form signature version of this method.

Declaration
public static void RemoveProperty(this PresentationDocument document, string propertySetName, string propertyName)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
| Improve this Doc View Source

SetPropertyValue(AssemblyDocument, String, Object)

Set the specified AssemblyDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. This is the short-form signature.

Declaration
public static void SetPropertyValue(this AssemblyDocument document, string propertyName, object value)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertyName

Property Name as a string
System.Object value

Property value
| Improve this Doc View Source

SetPropertyValue(AssemblyDocument, String, String, Object)

Set the specified AssemblyDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. The long signature function must be used to specify custom property groups.

Declaration
public static void SetPropertyValue(this AssemblyDocument document, string propertySetName, string propertyName, object value)
Parameters
Type Name Description
Inventor.AssemblyDocument document

Inventor.AssemblyDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
System.Object value
| Improve this Doc View Source

SetPropertyValue(Document, String, Object)

Set the specified document property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. This is the short-form signature.

Declaration
public static void SetPropertyValue(this Document document, string propertyName, object value)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertyName

Property Name as a string
System.Object value

Property value
| Improve this Doc View Source

SetPropertyValue(Document, String, String, Object)

Set the specified document property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. The long signature function must be used to specify custom property groups.

Declaration
public static void SetPropertyValue(this Document document, string propertySetName, string propertyName, object value)
Parameters
Type Name Description
Inventor.Document document

Inventor.Document
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
System.Object value
| Improve this Doc View Source

SetPropertyValue(DrawingDocument, String, Object)

Set the specified DrawingDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. This is the short-form signature.

Declaration
public static void SetPropertyValue(this DrawingDocument document, string propertyName, object value)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertyName

Property Name as a string
System.Object value

Property value
| Improve this Doc View Source

SetPropertyValue(DrawingDocument, String, String, Object)

Set the specified DrawingDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. The long signature function must be used to specify custom property groups.

Declaration
public static void SetPropertyValue(this DrawingDocument document, string propertySetName, string propertyName, object value)
Parameters
Type Name Description
Inventor.DrawingDocument document

Inventor.DrawingDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
System.Object value
| Improve this Doc View Source

SetPropertyValue(PartDocument, String, Object)

Set the specified Partdocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. This is the short-form signature.

Declaration
public static void SetPropertyValue(this PartDocument document, string propertyName, object value)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertyName

Property Name as a string
System.Object value

Property value
| Improve this Doc View Source

SetPropertyValue(PartDocument, String, String, Object)

Set the specified PartDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. The long signature function must be used to specify custom property groups.

Declaration
public static void SetPropertyValue(this PartDocument document, string propertySetName, string propertyName, object value)
Parameters
Type Name Description
Inventor.PartDocument document

Inventor.PartDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
System.Object value
| Improve this Doc View Source

SetPropertyValue(PresentationDocument, String, Object)

Set the specified Presentationdocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. This is the short-form signature.

Declaration
public static void SetPropertyValue(this PresentationDocument document, string propertyName, object value)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertyName

Property Name as a string
System.Object value

Property value
| Improve this Doc View Source

SetPropertyValue(PresentationDocument, String, String, Object)

Set the specified PresentationDocument property's value. If the iproperty name exist it will set the value. If the name does not exist, it will add the property with the value you have specified in the "User Defined Properties" property set. The long signature function must be used to specify custom property groups.

Declaration
public static void SetPropertyValue(this PresentationDocument document, string propertySetName, string propertyName, object value)
Parameters
Type Name Description
Inventor.PresentationDocument document

Inventor.PresentationDocument
System.String propertySetName

Property Set Name as a string
System.String propertyName

Property Name as a string
System.Object value