Interface IDocuments
Gives access to documents.
Namespace: TopSolid.Kernel.Automating
Assembly: TopSolid.Kernel.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IDocumentsRemarks
This interface is available since v7.6.
Properties
| Name | Description |
|---|---|
| EditedDocument | Gets or sets the document being edited. |
| EditingContextDocument | Gets the context document in which the edited document is being edited. |
Methods
| Name | Description |
|---|---|
| CanExport(int, DocumentId) | Tells whether an exporter can export a document. |
| CanInclude(int, DocumentId) | Tells whether an importer can include into a document. |
| CanPrint(DocumentId) | Tells whether a document can be printed. |
| Close(DocumentId, bool, bool) | Closes a document. |
| CloseAll(bool, bool) | Closes all documents. |
| Consult(DocumentId) | Opens a document in read only. |
| Drop(DocumentId) | Drops a document into the document being edited. |
| EnsureIsDirty(ref DocumentId) | Ensures that a document is dirty before performing modifications. |
| Exists(DocumentId) | Tells whether a document still exists. |
| Export(int, DocumentId, string) | Exports a document to a file with conversion. |
| ExportWithOptions(int, List<KeyValue>, DocumentId, string) | Exports a document to a file with conversion using specified options. |
| Freeze(DocumentId) | Freezes a document. |
| GetCurrentCulture(DocumentId) | Gets the document current culture. |
| GetDocument(PdmObjectId) | Gets the document corresponding to the last minor revision of a document PDM object. |
| GetDocuments() | Gets all the documents loaded into memory. |
| GetMinorRevisionDocument(PdmMinorRevisionId) | Gets the document corresponding to a PDM minor revision. |
| GetName(DocumentId) | Gets the name of a document. |
| GetOpenDocuments() | Gets the open documents. |
| GetPdmMinorRevision(DocumentId) | Gets the PDM minor revision corresponding to a document. |
| GetPdmObject(DocumentId) | Gets the PDM object corresponding to a document. |
| GetProperties(DocumentId) | Gets the full names of the properties of a document. |
| GetPropertyBooleanValue(DocumentId, string) | Gets the value of a document Boolean property. |
| GetPropertyDateTimeValue(DocumentId, string) | Gets the value of a document date and time property. |
| GetPropertyIntegerValue(DocumentId, string) | Gets the value of a document integer property. |
| GetPropertyLocalizedDomainName(DocumentId, string) | Gets the localized domain name of a document property. |
| GetPropertyLocalizedName(DocumentId, string) | Gets the localized name of a document property. |
| GetPropertyRealUnit(DocumentId, string, out UnitType, out string) | Gets the unit of a document real property. |
| GetPropertyRealValue(DocumentId, string) | Gets the value of a document real property. |
| GetPropertyTextValue(DocumentId, string) | Gets the value of a document text property. |
| GetPropertyType(DocumentId, string) | Gets the type of a document property. |
| GetReferencedDocuments(DocumentId, bool) | Gets the documents referenced by a document. |
| GetSynchronizedDocuments(DocumentId) | Gets the documents synchronized with a document. |
| GetTypeFullName(DocumentId) | Gets the full name of the type of a document. |
| GetTypeGuid(DocumentId) | Gets the GUID of the type of a document. |
| GetUniversalId(DocumentId, out string, out string) | Gets the universal identifier of a document. |
| Import(int, string, PdmObjectId, out List<string>, out List<DocumentId>) | Imports a file with conversion into a project or one of its folders. |
| ImportWithOptions(int, List<KeyValue>, string, PdmObjectId, out List<string>, out List<DocumentId>) | Imports a file with conversion into a project or one of its folders using specified options. |
| Include(int, string, DocumentId, out List<string>, out List<DocumentId>) | Imports a file with conversion into an existing document. |
| IncludeWithOptions(int, List<KeyValue>, string, DocumentId, out List<string>, out List<DocumentId>) | Imports a file with conversion into an existing document using specified options. |
| IsDirty(DocumentId) | Tells whether a document is dirty. |
| IsFreezable(DocumentId) | Tells whether a document may be frozen. |
| IsFrozen(DocumentId) | Tells whether a document is frozen. |
| IsInvalid(DocumentId) | Tells whether a document is invalid. |
| IsIsUnexportableDocument(DocumentId) | Determines whether the document is unexportable. |
| IsSynchronized(DocumentId) | Tells whether a document is synchronized with other documents. |
| IsUnmovableDocument(DocumentId) | Determines whether the document is movable. |
| IsUnsynchronizableDocument(DocumentId) | Determines whether the document is unsynchronizable. |
| IsVirtualDocument(DocumentId) | Determines whether the document is virtual. |
| NeedsRefreshing(DocumentId) | Tells whether a document needs refreshing. |
| Open(ref DocumentId) | Opens a document. |
| Print(DocumentId, PrintColorMapping, int) | Prints a document to the active printer. |
| Rebuild(DocumentId) | Rebuilds a document. |
| Refresh(DocumentId) | Refreshes a document. |
| Save(DocumentId) | Saves a document. |
| SaveAs(DocumentId, PdmObjectId, string) | Saves a document as a new document. |
| SetCurrentCulture(DocumentId, CultureInfo) | Sets the document current culture. |
| SetName(DocumentId, string) | Sets the name of a document. |
| SetUnexportableDocumentMode(DocumentId, bool) | Sets the unexportable document mode. |
| SetUniversalId(DocumentId, string, string) | Sets the universal identifier of a document. |
| SetUnmovableDocumentMode(DocumentId, bool) | Sets the unmovable document mode. |
| SetUnsynchronizableDocumentMode(DocumentId, bool) | Sets the unsynchronizable document mode. |
| SetVirtualDocumentMode(DocumentId, bool) | Sets the virtual document mode. |
| SubscribeToEvents(int, string) | Subscribes to documents events. |
| SubscribeToEventsTcp(int, string, string, int) | Subscribes to documents events using TCP connection. |
| Unfreeze(DocumentId) | Unfreezes a document. |
| UnsubscribeFromEvents(string) | Unsubscribes from documents events. |
| UnsubscribeFromEventsTcp(string, string, int) | Unsubscribes from documents events using TCP connection. |
| Update(DocumentId, bool) | Updates a document. |
| zExportToTopglTF(DocumentId, string, string, bool, bool, bool, bool, bool, bool, bool, int, Color) | Exports the document to TopgltF. |
| zExportToTopglTFWithRepresentation(DocumentId, string, string, string, bool, bool, bool, bool, bool, bool, int, Color) | Exports the document to TopgltF. |