Pré. | Proc. |
DocumentGenerator Class
The DocumentGenerator Class provides an interface to the document and web reporting facilities, which you can use to generate reports on specific Packages, diagrams and elements in your model. This Class is accessed from the Repository Class using the CreateDocumentGenerator() method.
DocumentGenerator Attributes
Attribute |
Remarks |
See also |
---|---|---|
ObjectType |
ObjectType Notes: Read only Distinguishes objects referenced through a Dispatch interface. |
ObjectType |
DocumentGenerator Methods
Method |
Remarks |
See also |
---|---|---|
DocumentConnector (long connectorID, long nDepth, string templateName) |
Boolean Notes: Documents a connector. Parameters:
|
|
DocumentCustomData (string XML, long nDepth, string templateName) |
Boolean Notes: Documents information based on the data supplied. Parameters:
|
Example Template Fragment Script |
DocumentDiagram (long diagramID, long nDepth, string templateName) |
Boolean Notes: Documents a diagram. Parameters:
|
|
DocumentElement (long elementID, long nDepth, string templateName) |
Boolean Notes: Documents an element. Parameters:
|
|
DocumentModelAuthor (string name, long nDepth, string templateName) |
Boolean Notes: Documents a model author. Parameters:
|
|
DocumentModelClient (string name, long nDepth, string templateName) |
Boolean Notes: Documents a single model client. Parameters:
|
|
DocumentModelGlossary (long id, long nDepth, string templateName) |
Boolean Notes: Documents a single model glossary term. Parameters:
|
|
DocumentModelIssue (long id, long nDepth, string templateName) |
Boolean Notes: Documents a single model issue. Parameters:
|
|
DocumentModelResource (string name, long nDepth, string templateName) |
Boolean Notes: Documents a single model resource. Parameters:
|
|
DocumentModelRole (string name, long nDepth, string templateName) |
Boolean Notes: Documents a single model role. Parameters:
|
|
DocumentModelTask (long id, long nDepth, string templateName) |
Boolean Notes: Documents a single model task. Parameters:
|
|
DocumentPackage (long packageID,
|
Boolean Notes: Documents a Package. Parameters:
|
|
GetDocumentAsRTF() |
Read Only. Returns a string value of the document in raw Rich Text Format. |
|
GetProjectConstant (string nameVal) |
String Notes: Returns the value of a Project Constant. Parameters:
|
Project Constants |
GetLastError () |
String Notes: Returns a string value describing the most recent error that occurred in relation to this object. |
|
InsertBreak (long breakType) |
Boolean Notes: Inserts a break into the report at the current location. Parameters:
|
DocumentBreak |
InsertCoverPageDocument (string Name) |
Boolean Notes: Inserts the Coverpage into the document at the current location. The style sheet is applied to the document before it is insert into the generated document. Parameters:
|
|
InsertHyperlink (string Name, string URL) |
Boolean Notes: Inserts a hyperlink at the current location. If you use a URL with the #BOOKMARKNAME syntax, the hyperlink will link to another part of the document. Parameters:
|
|
InsertLinkedDocument (string guid) |
Boolean Notes: Inserts a Linked Document into the report at the current location. A Linked Document can used to set the header and footer of the report. These are taken from the first Linked Document added to the report. Parameters:
|
|
InsertTableOfContents |
Boolean Notes: Inserts a Table of Contents at the current position. |
|
InsertTeamReviewPost (string path) |
Boolean Notes: Inserts a Model Library posting into the report at the current location. Parameters:
|
|
InsertTemplate (string templateName) |
Notes: Inserts the contents of the template directly into the report. Parameters:
|
|
InsertText (string text,
|
Boolean Notes: Inserts static text into the report at the current location. A carriage return is not included; if you need to use one, you can add it manually. Parameters:
|
|
InsertTOCDocument (string name) |
Boolean Notes: Inserts the Table of Contents into the document at the current location. Note: The stylesheet is applied to the document before it is insert into the generated document. Parameters:
|
|
LoadDocument(string FileName) |
Boolean Notes: Inserts an external document into the currently generated file. Parameters:
|
|
NewDocument (string templateName) |
Boolean Notes: Starts a new document; you call this before attempting to document anything else. Parameters:
|
|
ReplaceField (string fieldname,
|
Boolean Notes: Replaces the 'Section' field identified by the fieldname parameter with the value provided in fieldvalue. For example: ReplaceField ("Element.Alias", "MyAlias") If you call this function more than once with the same fieldname, the field only has the most recent value set. Parameters:
|
|
SaveDocument (string filename,
|
Boolean Notes: Saves the document to disk. Parameters:
|
DocumentType |
SetPageOrientation (long pageOrientation) |
Boolean Notes: Sets the current page orientation. Parameters:
|
DocumentPageOrientation |
SetProjectConstant (string newNameVal, string newValue) |
Boolean Notes: Sets a Project Constant for the documentation generator; this is saved in the current model. Parameters:
|
Project Constants |
SetStyleSheetDocument (string name) |
Boolean Notes: Sets the Stylesheet to be used for TOC, Coverpage and templates used. This can be called before NewDocument. Parameters:
|
|
SetSuppressProfile (name) |
Boolean Notes: Sets the Suppress Profile to be used during report generation. Parameters:
|
Suppress Sections |