java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.XBRLDocumentationDlg

public class XBRLDocumentationDlg
extends COMIDispatchObject

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
`void`	`allDetails(boolean bDetailsOn)`	Switches all Details on or off.
`COMIDispatchObject`	`getApplication()`	Returns the Application object.
`boolean`	`getCreateDiagramsFolder()`	Returnssets a value indicating whether to create a separate folder for diagrams or not.
`Enums.SPYImageKind`	`getDiagramFormat()`	Returnssets the image kind that is generated.
`boolean`	`getEmbedCSSInHTML()`	Returnssets a value indicating whether to embed the CSS in the HTML or not.
`boolean`	`getEmbedDiagrams()`	Returnssets a value indicating whether to embed the diagrams in the document or not.
`boolean`	`getIncludeCalculationLinkroles()`	Returnssets a value indicating whether Calculation linkroles are included.
`boolean`	`getIncludeDefinitionLinkroles()`	Returnssets a value indicating whether Definition linkroles are included.
`boolean`	`getIncludeGenericLinkroles()`	Returnssets a value indicating whether generic linkroles are included.
`boolean`	`getIncludeGlobalElements()`	Returnssets a value indicating whether Global elements are included.
`boolean`	`getIncludeNamespacePrefixes()`	Returnssets a value indicating whether Namespace prefixes are included.
`boolean`	`getIncludeOverview()`	Returnssets a value indicating whether an overview is included.
`boolean`	`getIncludePresentationLinkroles()`	Returnssets a value indicating whether Presentation linkroles are included.
`GUID`	`getInterfaceIID()`
`Enums.SPYDialogAction`	`getOptionsDialogAction()`	Specifies how the options dialog is handled.
`java.lang.String`	`getOutputFile()`	Returnssets the output file.
`Enums.SPYDialogAction`	`getOutputFileDialogAction()`	Specifies how the file dialog is handled.
`Enums.SPYSchemaDocumentationFormat`	`getOutputFormat()`	Returnssets the output format.
`COMIDispatchObject`	`getParent()`	Returns the Parent object.
`boolean`	`getShortQualifiedName()`	Returnssets a value indicating whether short qualified names are used.
`boolean`	`getShowDiagram()`	Returnssets a value indicating whether diagrams are shown.
`boolean`	`getShowImportedElements()`	Returnssets a value indicating whether imported XBRL elements are included.
`boolean`	`getShowLabels()`	Returnssets a value indicating whether labels are shown.
`boolean`	`getShowLinkbaseReferences()`	Returnssets a value indicating whether linkbase references are shown.
`boolean`	`getShowMessages()`	Returnssets a value indicating whether messages are shown.
`boolean`	`getShowProgressBar()`	Returnssets a value indicating whether a progress bar is displayed during the generation.
`boolean`	`getShowProperties()`	Returnssets a value indicating whether properties are shown.
`boolean`	`getShowReferences()`	Returnssets a value indicating whether references are shown.
`boolean`	`getShowResult()`	Returnssets a value indicating whether the document is shown after the generation.
`java.lang.String`	`getSPSFile()`	Returnssets a value indicating the location of the SPS file.
`boolean`	`getUseFixedDesign()`	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.
`void`	`includeAll(boolean bInclude)`	Switches all Includes on or off.
`void`	`setCreateDiagramsFolder(boolean newValue)`	Returnssets a value indicating whether to create a separate folder for diagrams or not.
`void`	`setDiagramFormat(Enums.SPYImageKind newValue)`	Returnssets the image kind that is generated.
`void`	`setEmbedCSSInHTML(boolean newValue)`	Returnssets a value indicating whether to embed the CSS in the HTML or not.
`void`	`setEmbedDiagrams(boolean newValue)`	Returnssets a value indicating whether to embed the diagrams in the document or not.
`void`	`setIncludeCalculationLinkroles(boolean newValue)`	Returnssets a value indicating whether Calculation linkroles are included.
`void`	`setIncludeDefinitionLinkroles(boolean newValue)`	Returnssets a value indicating whether Definition linkroles are included.
`void`	`setIncludeGenericLinkroles(boolean newValue)`	Returnssets a value indicating whether generic linkroles are included.
`void`	`setIncludeGlobalElements(boolean newValue)`	Returnssets a value indicating whether Global elements are included.
`void`	`setIncludeNamespacePrefixes(boolean newValue)`	Returnssets a value indicating whether Namespace prefixes are included.
`void`	`setIncludeOverview(boolean newValue)`	Returnssets a value indicating whether an overview is included.
`void`	`setIncludePresentationLinkroles(boolean newValue)`	Returnssets a value indicating whether Presentation linkroles are included.
`void`	`setOptionsDialogAction(Enums.SPYDialogAction newValue)`	Specifies how the options dialog is handled.
`void`	`setOutputFile(java.lang.String newValue)`	Returnssets the output file.
`void`	`setOutputFileDialogAction(Enums.SPYDialogAction newValue)`	Specifies how the file dialog is handled.
`void`	`setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue)`	Returnssets the output format.
`void`	`setShortQualifiedName(boolean newValue)`	Returnssets a value indicating whether short qualified names are used.
`void`	`setShowDiagram(boolean newValue)`	Returnssets a value indicating whether diagrams are shown.
`void`	`setShowImportedElements(boolean newValue)`	Returnssets a value indicating whether imported XBRL elements are included.
`void`	`setShowLabels(boolean newValue)`	Returnssets a value indicating whether labels are shown.
`void`	`setShowLinkbaseReferences(boolean newValue)`	Returnssets a value indicating whether linkbase references are shown.
`void`	`setShowMessages(boolean newValue)`	Returnssets a value indicating whether messages are shown.
`void`	`setShowProgressBar(boolean newValue)`	Returnssets a value indicating whether a progress bar is displayed during the generation.
`void`	`setShowProperties(boolean newValue)`	Returnssets a value indicating whether properties are shown.
`void`	`setShowReferences(boolean newValue)`	Returnssets a value indicating whether references are shown.
`void`	`setShowResult(boolean newValue)`	Returnssets a value indicating whether the document is shown after the generation.
`void`	`setSPSFile(java.lang.String newValue)`	Returnssets a value indicating the location of the SPS file.
`void`	`setUseFixedDesign(boolean newValue)`	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

addListener, getProperty, getProperty, invoke, removeListener, setProperty, setProperty

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

dispose, equals, getCOMInterfacePointer, isNull

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getInterfaceIID
  
  public GUID getInterfaceIID()
- getApplication
  
  public COMIDispatchObject getApplication() throws AutomationException
  
  Returns the Application object.
  
  Throws:
  
  AutomationException
- getParent
  
  public COMIDispatchObject getParent() throws AutomationException
  
  Returns the Parent object.
  
  Throws:
  
  AutomationException
- getOptionsDialogAction
  
  public Enums.SPYDialogAction getOptionsDialogAction() throws AutomationException
  
  Specifies how the options dialog is handled.
  
  Throws:
  
  AutomationException
- setOptionsDialogAction
  
  public void setOptionsDialogAction(Enums.SPYDialogAction newValue) throws AutomationException
  
  Specifies how the options dialog is handled.
  
  Throws:
  
  AutomationException
- getOutputFileDialogAction
  
  public Enums.SPYDialogAction getOutputFileDialogAction() throws AutomationException
  
  Specifies how the file dialog is handled.
  
  Throws:
  
  AutomationException
- setOutputFileDialogAction
  
  public void setOutputFileDialogAction(Enums.SPYDialogAction newValue) throws AutomationException
  
  Specifies how the file dialog is handled.
  
  Throws:
  
  AutomationException
- getShowProgressBar
  
  public boolean getShowProgressBar() throws AutomationException
  
  Returnssets a value indicating whether a progress bar is displayed during the generation.
  
  Throws:
  
  AutomationException
- setShowProgressBar
  
  public void setShowProgressBar(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether a progress bar is displayed during the generation.
  
  Throws:
  
  AutomationException
- getOutputFile
  
  public java.lang.String getOutputFile() throws AutomationException
  
  Returnssets the output file.
  
  Throws:
  
  AutomationException
- setOutputFile
  
  public void setOutputFile(java.lang.String newValue) throws AutomationException
  
  Returnssets the output file.
  
  Throws:
  
  AutomationException
- getOutputFormat
  
  public Enums.SPYSchemaDocumentationFormat getOutputFormat() throws AutomationException
  
  Returnssets the output format.
  
  Throws:
  
  AutomationException
- setOutputFormat
  
  public void setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue) throws AutomationException
  
  Returnssets the output format.
  
  Throws:
  
  AutomationException
- getEmbedCSSInHTML
  
  public boolean getEmbedCSSInHTML() throws AutomationException
  
  Returnssets a value indicating whether to embed the CSS in the HTML or not.
  
  Throws:
  
  AutomationException
- setEmbedCSSInHTML
  
  public void setEmbedCSSInHTML(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether to embed the CSS in the HTML or not.
  
  Throws:
  
  AutomationException
- getDiagramFormat
  
  public Enums.SPYImageKind getDiagramFormat() throws AutomationException
  
  Returnssets the image kind that is generated.
  
  Throws:
  
  AutomationException
- setDiagramFormat
  
  public void setDiagramFormat(Enums.SPYImageKind newValue) throws AutomationException
  
  Returnssets the image kind that is generated.
  
  Throws:
  
  AutomationException
- getEmbedDiagrams
  
  public boolean getEmbedDiagrams() throws AutomationException
  
  Returnssets a value indicating whether to embed the diagrams in the document or not.
  
  Throws:
  
  AutomationException
- setEmbedDiagrams
  
  public void setEmbedDiagrams(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether to embed the diagrams in the document or not.
  
  Throws:
  
  AutomationException
- getCreateDiagramsFolder
  
  public boolean getCreateDiagramsFolder() throws AutomationException
  
  Returnssets a value indicating whether to create a separate folder for diagrams or not.
  
  Throws:
  
  AutomationException
- setCreateDiagramsFolder
  
  public void setCreateDiagramsFolder(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether to create a separate folder for diagrams or not.
  
  Throws:
  
  AutomationException
- getShowResult
  
  public boolean getShowResult() throws AutomationException
  
  Returnssets a value indicating whether the document is shown after the generation.
  
  Throws:
  
  AutomationException
- setShowResult
  
  public void setShowResult(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether the document is shown after the generation.
  
  Throws:
  
  AutomationException
- includeAll
  
  public void includeAll(boolean bInclude) throws AutomationException
  
  Switches all Includes on or off.
  
  Throws:
  
  AutomationException
- allDetails
  
  public void allDetails(boolean bDetailsOn) throws AutomationException
  
  Switches all Details on or off.
  
  Throws:
  
  AutomationException
- getIncludeOverview
  
  public boolean getIncludeOverview() throws AutomationException
  
  Returnssets a value indicating whether an overview is included.
  
  Throws:
  
  AutomationException
- setIncludeOverview
  
  public void setIncludeOverview(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether an overview is included.
  
  Throws:
  
  AutomationException
- getIncludeNamespacePrefixes
  
  public boolean getIncludeNamespacePrefixes() throws AutomationException
  
  Returnssets a value indicating whether Namespace prefixes are included.
  
  Throws:
  
  AutomationException
- setIncludeNamespacePrefixes
  
  public void setIncludeNamespacePrefixes(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether Namespace prefixes are included.
  
  Throws:
  
  AutomationException
- getIncludeGlobalElements
  
  public boolean getIncludeGlobalElements() throws AutomationException
  
  Returnssets a value indicating whether Global elements are included.
  
  Throws:
  
  AutomationException
- setIncludeGlobalElements
  
  public void setIncludeGlobalElements(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether Global elements are included.
  
  Throws:
  
  AutomationException
- getIncludeDefinitionLinkroles
  
  public boolean getIncludeDefinitionLinkroles() throws AutomationException
  
  Returnssets a value indicating whether Definition linkroles are included.
  
  Throws:
  
  AutomationException
- setIncludeDefinitionLinkroles
  
  public void setIncludeDefinitionLinkroles(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether Definition linkroles are included.
  
  Throws:
  
  AutomationException
- getIncludePresentationLinkroles
  
  public boolean getIncludePresentationLinkroles() throws AutomationException
  
  Returnssets a value indicating whether Presentation linkroles are included.
  
  Throws:
  
  AutomationException
- setIncludePresentationLinkroles
  
  public void setIncludePresentationLinkroles(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether Presentation linkroles are included.
  
  Throws:
  
  AutomationException
- getIncludeCalculationLinkroles
  
  public boolean getIncludeCalculationLinkroles() throws AutomationException
  
  Returnssets a value indicating whether Calculation linkroles are included.
  
  Throws:
  
  AutomationException
- setIncludeCalculationLinkroles
  
  public void setIncludeCalculationLinkroles(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether Calculation linkroles are included.
  
  Throws:
  
  AutomationException
- getShowDiagram
  
  public boolean getShowDiagram() throws AutomationException
  
  Returnssets a value indicating whether diagrams are shown.
  
  Throws:
  
  AutomationException
- setShowDiagram
  
  public void setShowDiagram(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether diagrams are shown.
  
  Throws:
  
  AutomationException
- getShowLabels
  
  public boolean getShowLabels() throws AutomationException
  
  Returnssets a value indicating whether labels are shown.
  
  Throws:
  
  AutomationException
- setShowLabels
  
  public void setShowLabels(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether labels are shown.
  
  Throws:
  
  AutomationException
- getShowReferences
  
  public boolean getShowReferences() throws AutomationException
  
  Returnssets a value indicating whether references are shown.
  
  Throws:
  
  AutomationException
- setShowReferences
  
  public void setShowReferences(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether references are shown.
  
  Throws:
  
  AutomationException
- getShowLinkbaseReferences
  
  public boolean getShowLinkbaseReferences() throws AutomationException
  
  Returnssets a value indicating whether linkbase references are shown.
  
  Throws:
  
  AutomationException
- setShowLinkbaseReferences
  
  public void setShowLinkbaseReferences(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether linkbase references are shown.
  
  Throws:
  
  AutomationException
- getShortQualifiedName
  
  public boolean getShortQualifiedName() throws AutomationException
  
  Returnssets a value indicating whether short qualified names are used.
  
  Throws:
  
  AutomationException
- setShortQualifiedName
  
  public void setShortQualifiedName(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether short qualified names are used.
  
  Throws:
  
  AutomationException
- getShowImportedElements
  
  public boolean getShowImportedElements() throws AutomationException
  
  Returnssets a value indicating whether imported XBRL elements are included.
  
  Throws:
  
  AutomationException
- setShowImportedElements
  
  public void setShowImportedElements(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether imported XBRL elements are included.
  
  Throws:
  
  AutomationException
- getUseFixedDesign
  
  public boolean getUseFixedDesign() throws AutomationException
  
  Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.
  
  Throws:
  
  AutomationException
- setUseFixedDesign
  
  public void setUseFixedDesign(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.
  
  Throws:
  
  AutomationException
- getSPSFile
  
  public java.lang.String getSPSFile() throws AutomationException
  
  Returnssets a value indicating the location of the SPS file.
  
  Throws:
  
  AutomationException
- setSPSFile
  
  public void setSPSFile(java.lang.String newValue) throws AutomationException
  
  Returnssets a value indicating the location of the SPS file.
  
  Throws:
  
  AutomationException
- getIncludeGenericLinkroles
  
  public boolean getIncludeGenericLinkroles() throws AutomationException
  
  Returnssets a value indicating whether generic linkroles are included.
  
  Throws:
  
  AutomationException
- setIncludeGenericLinkroles
  
  public void setIncludeGenericLinkroles(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether generic linkroles are included.
  
  Throws:
  
  AutomationException
- getShowProperties
  
  public boolean getShowProperties() throws AutomationException
  
  Returnssets a value indicating whether properties are shown.
  
  Throws:
  
  AutomationException
- setShowProperties
  
  public void setShowProperties(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether properties are shown.
  
  Throws:
  
  AutomationException
- getShowMessages
  
  public boolean getShowMessages() throws AutomationException
  
  Returnssets a value indicating whether messages are shown.
  
  Throws:
  
  AutomationException
- setShowMessages
  
  public void setShowMessages(boolean newValue) throws AutomationException
  
  Returnssets a value indicating whether messages are shown.
  
  Throws:
  
  AutomationException

Class XBRLDocumentationDlg

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject

Method Summary

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

Methods inherited from class java.lang.Object

Method Details