Class Documents

Index

Methods

getActiveDocument getActiveTags getAllTags getDocumentById getDocumentByName getDocumentRecordCode getDocumentRecordId getDocuments getDocumentSuiteId getDocumentSuiteVersionId getTagById getTagsByName getTemplateSuiteId getTemplateSuiteVersionId isValid

Methods

`Static`getActiveDocument

getActiveDocument(): Document
Returns Document which contains element that triggered the currently running script.

Returns Document
Document which contains element that triggered the currently running script.
- Defined in project.d.ts:152

`Static`getActiveTags

getActiveTags(): Tag[]
Returns all tags that are used on any element in the current document suite.

Returns Tag[]
List of Tags.
- Defined in project.d.ts:220

`Static`getAllTags

getAllTags(): Tag[]
Returns all tags available for the current workspace.

Returns Tag[]
List of Tags.
- Defined in project.d.ts:214

`Static`getDocumentById

getDocumentById(documentId: string): Document
Returns Document by its ID.
Parameters
- documentId: string
  Id of document.
Returns Document
Document or null if not found.
- Defined in project.d.ts:165

`Static`getDocumentByName

getDocumentByName(name: string): Document
Returns Document by its name.
Parameters
- name: string
  Name of document.
Returns Document
Document or null if not found.
- Defined in project.d.ts:172

`Static`getDocumentRecordCode

getDocumentRecordCode(): string
Returns document record code of current document suite.

Returns string
Document record Code
- Defined in project.d.ts:196

`Static`getDocumentRecordId

getDocumentRecordId(): number
Returns document record id of current document suite.

Returns number
Document record ID
- Defined in project.d.ts:190

`Static`getDocuments

getDocuments(): Document[]
Returns all documents in the current document suite.

Returns Document[]
All documents in the current document suite
- Defined in project.d.ts:158

`Static`getDocumentSuiteId

getDocumentSuiteId(): string
Returns ID of current document suite.

Returns string
Document Suite ID
- Defined in project.d.ts:184

`Static`getDocumentSuiteVersionId

getDocumentSuiteVersionId(): string
Returns id of the current document suite version.

Returns string
Document Suite Version ID
- Defined in project.d.ts:178

`Static`getTagById

getTagById(tagId: string): Tag
Returns Tag by its ID.
Parameters
- tagId: string
  ID of tag.
Returns Tag
Tag, or null if not found.
- Defined in project.d.ts:227

`Static`getTagsByName

getTagsByName(tagName: string): Tag[]
Returns all tags with specified name.
Parameters
- tagName: string
  Name of tag.
Returns Tag[]
List of Tags.
- Defined in project.d.ts:234

`Static`getTemplateSuiteId

getTemplateSuiteId(): string
Returns ID of current template suite.

Returns string
Template Suite ID
- Defined in project.d.ts:202

`Static`getTemplateSuiteVersionId

getTemplateSuiteVersionId(): string
Returns ID of current template suite version.

Returns string
Template Suite ID
- Defined in project.d.ts:208

`Static`isValid

isValid(): boolean
Returns whether all documents in the current document suite are valid for save.

Returns boolean
True if documents are valid for save, false otherwise.
- Defined in project.d.ts:240