TranslatorAddIn Object

Derived from: ApplicationAddIn Object

Description

Object that represents an Translator AddIn inside Autodesk Inventor.

Remarks

See the Translator Options page for details about the supported options for each of the translators. The samples below are also very useful in understanding the steps required to use a translator add-in.

Methods

Name	Description
Activate	Creates and initializes the AddIn. No effect if AddIn already active.
Deactivate	Invokes the shutdown sequence on the AddIn. No effect if AddIn inactive.
GetThumbnail	Obtains the thumbnail, if any, for the given data-source. Could be a metafile handle (long) or the interface to a StdPicture object.
Open	Open the data specified by the data-source.
SaveCopyAs	Save the document to the specified data-source.
ShowOpenOptions	Show the open options for the specified data-source. This method is only called if True was returned from HasOpenOptions.
ShowSaveCopyAsOptions	Show the save options for the specified data-source. This method is only called if True was returned from HasSaveCopyAsOptions.

Properties

Name	Description
Activated	Gets a Boolean flag indicating whether this AddIn is currently active in the session.
AddInType	Gets the constant that indicates the type of this AddIn.
Application	Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
Automation	Property that returns the Add-in's automation interface (if any). Fails if the Add-in is currently inactive.
ClassIdString	Gets the CLSID of the AddIn as the string used in the class moniker.
ClientId	Property that returns a GUID in string format that uniquely identifies this Add-in. This GUID is used as an identifier when creating Add-in specific objects such as user interface elements, client features, etc.
DataVersion	Gets and sets the current data version of the AddIn. This value corresponds to the 'Data Version' registry entry in the AddIn's registry hive.
Description	Gets the description of the AddIn.
DisplayName	Gets the displayable name of the AddIn.
FileExtensions	Property that gets the semicolon-separated list of the native file extensions that this translator reads from and/or writes to.
FilterText	Property that gets the filter text string to be displayed in the file dialog for this translator.
HasOpenOptions	Gets whether the translator has options available for opening the specified data-source.
HasSaveCopyAsOptions	Gets whether the translator has options available for saving the specified data-source.
Hidden	Gets and sets whether the AddIn is hidden or not.
LicenseStatus	Gets the license status of the AddIn.
LoadAutomatically	Gets/Sets whether the add-in loads automatically based on the load behavior specified for the add-in. If set to False, the add-in needs to be manually loaded by the user.
LoadBehavior	Gets a constant indicating the load behavior (load time) of the add-in. This applies only if the LoadAutomatically property is set to True.
Location	Property that returns the full file name of the dll associated with this Add-in.
Parent	Property that returns the parent Application object.
ProgId	Gets the ProgID of the AddIn.
ShortDisplayName	Property that returns the short display name of the Add-in. Used in places to succinctly identify the AddIn inside Inventor's UI.
SupportsImportInto	Property that returns semicolon-separated Inventor file types that this translator supports importing into. Example: ".iam;.ipt."
SupportsOpen	Property that gets whether this translator supports opening files.
SupportsOpenInto	Property that returns semicolon-separated Inventor file types that this translator supports opening into. Example: ".iam;.ipt."
SupportsSaveCopyAs	Property that gets whether this translator supports saving data to a file.
SupportsSaveCopyAsFrom	Property that returns semicolon-separated Inventor file types that this translator supports saving from. Example: ".iam;.ipt."
TranslatorAvailable	Gets/Sets a Boolean flag indicating whether this Translator is available to Inventor, regardless of whether it is loaded or not.
Type	Returns an ObjectTypeEnum indicating this object's type.
UserInterfaceVersion	Property that returns the version of the user interface of the add-in. Incrementing this version results in all of the add-in"s UI getting cleaned up during Inventor start-up.
UserUnloadable	Gets and sets whether the AddIn is allowed to be unloaded by the user.

Samples

Name	Description
Open a Catia file using the Catia Translator Sample	This sample demonstrates how open an Catia file using the Catia translator add-in.
Open an NX file suing the NX Translator Sample	This sample demonstrates how open an NX file using the NX translator add-in.
Open Rhino Translator Sample	This sample demonstrates how to opening a Rhino file using the Rhino translator add-in.
Open an STL file using the STL Translator Sample	This sample demonstrates how open an STL file using the STL translator add-in.
Save as DWF Translator Sample	This sample demonstrates how to save a DWF file using the DWF translator add-in.
Save as DWG Translator Sample	This sample demonstrates how to save a DWG file using the DWG translator add-in.
Save as DXF Translator Sample	This sample demonstrates how to save a DXF file using the DXF translator add-in.
Save as IGES Translator Sample	This sample demonstrates how to save a IGES file using the IGES translator add-in.
Save as PDF Translator Sample	This sample demonstrates how to save a PDF file using the PDF translator add-in.
Save as STEP Translator Sample	This sample demonstrates how to save a STEP file using the STEP translator add-in.
Export to DWF	This sample demonstrates publishing of Inventor files in DWF format.
Export to DWG	This sample uses the DWG Translator Addin to publish to DWG.
Export to DXF	This sample uses the DXF Translator Addin to publish to DXF.
Export to IGES	This sample demonstrates exporting of Inventor files in IGES format.
Export to STEP	This sample demonstrates exporting of Inventor files in STEP format.
Export to PDF	This sample demonstrates exporting of Inventor files in PDF format.

Version

Introduced in version 4