Document Object Properties
The Document object provides the following properties, most of which are read-only. To affect some read-only properties requires user interaction or custom event procedures.
An object that represents a briefcase. If the parent object is a document, this is the briefcase to which the document is locked. If the parent object is a report (transmittal sheet), this is the briefcase that contains the report. Read-only.
Syntax
BriefCase As IASBriefCase
True if the user can edit this property, False if editing is not allowed. Read-only.
Syntax
CanEditProperty As Boolean
Specifies the way in which documents are locked when waiting lists are in use for project copies. The constant AS_CE_Rule contains enumerations of behaviors that you can specify for a project copy:
-
AS_CER_DEFAULT — default behavior
-
AS_CER_MERGE_WF — current behavior
-
AS_CER_NOT_ALLOWED — allow only one project copy
-
AS_CER_SERIAL_WITH_RELEASE — allow multiple project copies
-
AS_CER_SERIAL_WITH_TRANSFER — reserved for future use
Note:
If you want to change the concurrent engineering rule for a document that is in progress using script, you must add the ConcurrentEngineeringRule property to the SafeProperties registry setting.
Syntax
CanEditProperty As AS_CE_RULE
The date and time when the document was created. Read-only.
Syntax
Created As Date
An object that represents the person who created the document. Read-only.
Syntax
CreatedBy As IASUser
The names of the users assigned as the workflow definition managers of the document. Read-only.
Syntax
CWFManagers As String
An object that represents the current workflow definition state of the document. Read-only.
Syntax
CWFState As IASWorkflowState
The names of the users assigned as the to-do persons of the document. Read-only.
Syntax
CWFTodoPersons As String
An object that represents the document type of the document. Read-only.
Syntax
DocumentType As IASDocumentType
The file name (Display Name property) of the document or briefcase.
Syntax
FileName As String
Remarks
For events to occur when setting this property for a document, the RenameEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y. The default is N.
The file type (as registered in Windows on the current computer) of the document. Read-only.
Syntax
FileType As String
The URL to view the current document in Autodesk Forge. Can be modified with ChangeForgeURL Method.
Syntax
ForgeURL As String
The ID of the document that is unique among all vaults. Read-only.
Syntax
GlobalID As String
True if the document has incoming Meridian references. Read-only.
Syntax
HasIncomingReferences As Boolean
True if the document has outgoing Meridian references. Read-only.
Syntax
HasOutgoingReferences As Boolean
True if the document has Meridian redlines attached to it. Read-only.
Syntax
HasRedlines As Boolean
True if the rendition of the document has Meridian redlines attached to it. Read-only.
Syntax
HasRenditionRedlines As Boolean
A list of the hybrid part document names.
Syntax
HybridParts() As Array
Returns the ID of the current object. The value is unique within the current vault. For the ID value that is unique among all vaults, retrieve the GlobalID property value, if available. Read-only.
Syntax
ID As String
Long integer that represents one or more AS_IMPORTTYPE constants. Available only for new documents. Read-only.
Syntax
ImportType As AS_IMPORTTYPE
True if the document returned from Meridian Portal is changed. Read-only.
Syntax
IsChangedByPortal As Boolean
Example
This sample code releases a quick change if the document was not changed in Meridian Portal.
Copy
Sub ImportPackage_ChangeState (package, previousState, User)
Dim Doc, arrDoc, i
If package.Status = AS_IPS_Imported Then
arrDoc = Package.GetDocuments()
For i = 0 To Ubound(arrDoc)
Set Doc = Vault.GetDocument(arrDoc(i))
If Doc.Property("AMDocumentPropertySet._ISCHANGEDBYPORTAL") = False Then
' revoke quick change
Doc.RevokeChange
End If
Next
End If
End Sub
True if a working copy exists for the current document. Read-only.
Syntax
IsUnderRevision As Boolean
True if the specified value for the specified document property is unique within the current vault. Read-only.
Syntax
IsUniqueValue(PropertyName, Value) As Boolean
Layer translation table to use for translating the document layers when generating a PDF rendition from the document. Translation tables are created by your administrator in the Meridian Enterprise Server Administration Console.
Syntax
LayerTranslationTable As String
Gets the names of the page layouts in the current document.
Syntax
LayoutsNames As String
Returns
An array of names as strings.
Remarks
Use this property to retrieve the layout names to present to the user for selecting the layouts to render with the MeridianQueue.RegisterDocument property. Pass the selected layout names in the publishOptions parameter using the _RENDERLAYOUTS_ option described in Publishing And Rendering Options.
This property can also be used to access the data in multiple title blocks defined in a single drawing. For an example of usage, see DocCADLink_AfterReadMTBProperties event.
This property is intended for AutoCAD and Revit drawings only. If the document does not contain multiple title blocks or sheet properties with the names configured in the application link (AutoCAD or Revit tabs, respectively) settings of the vault configuration, the returned array is empty.
A Document object that represents the project copy that is locking the selected document. Read-only.
Syntax
LockingProjectCopy As IASDocument5
A Document object that represents the master document from which the current project copy document was copied. Read-only.
Syntax
MasterDocument As IASDocument5
The date and time when the document content was last modified. Read-only.
Syntax
Modified As Date
An object that represents the person who last modified the document content. Read-only.
Syntax
ModifiedBy As IASUser
An object that represents the parent folder of the document. Read-only.
Syntax
ParentFolder As IASFolder3
A Folder object that represents the parent project that contains the current project copy document. Read-only.
Syntax
ParentProject As IASFolder3
The relative path of the document from the root of the vault. Read-only.
Syntax
Path As String
An object that represents a project copy of the selected document. Read-only.
Syntax
ProjectCopy As IASProjectCopy
Gets or sets the value of the specified (String) document property.
Syntax
Property(Name) As Variant
The vault or Local Workspace path of the document and its rendition. Read-only.
Syntax
Rendition As String
The status of the current rendition stored in the vault. The property contains a long integer that represents one or more AS_RENDITION_STATUS constants. Read-only.
Syntax
RenditionStatus() As AS_RENDITION_STATUS
Remarks
When the content of the source document is replaced by a user, this property returns AS_RS_OUTDATED.
The revision number of the document.
Syntax
Revision As String
A server ShareID to get a transaction object from another process. Read-only.
Syntax
ShareID As String
The file size of the document content. Read-only.
Syntax
Size As Long
The text of the document's current workflow Status property.
Syntax
StatusText As String
An object that represents the user who owns the working copy of the document. Read-only.
Syntax
UnderRevisionBy As IASUser
The ID of the current revision of the document that is unique within the current vault. Read-only.
Syntax
VersionID As String
The action that the current to-do person is assigned to perform on the document. Read-only.
Syntax
WorkFlowAction As String
An object that represents the user assigned to manage the current document type workflow of the document. Read-only.
Syntax
WorkFlowManager As IASUser
An object that represents the current workflow state of the current workflow object. Read-only.
Syntax
WorkflowState As IASWorkflowState
An object that represents the user assigned as the to-do person of the document in the current document type workflow state. Read-only.
Syntax
WorkFlowTodoPerson As IASUser
BriefCase Property
