Package com.altova.automation.XMLSpy

Class SchemaDocumentationDlg

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.SchemaDocumentationDlg

public class SchemaDocumentationDlg
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 i_bDetailsOn)	method AllDetails
COMIDispatchObject	getApplication()	property Application
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	getGenerateRelativeLinks()	Returnssets a value indicating whether links to local files are relative (true) or absolute (false).
boolean	getIncludeAttributeGroups()	property IncludeAttributeGroups
boolean	getIncludeComplexTypes()	property IncludeComplexTypes
boolean	getIncludeGlobalAttributes()	Returnssets a value indicating whether global attributes are documented.
boolean	getIncludeGlobalElements()	property IncludeGlobalElements
boolean	getIncludeGroups()	property IncludeGroups
boolean	getIncludeIndex()	property IncludeIndex
boolean	getIncludeLocalAttributes()	Returnssets a value indicating whether local attributes are documented.
boolean	getIncludeLocalElements()	property IncludeLocalElements
boolean	getIncludeRedefines()	property IncludeRedefines
boolean	getIncludeReferencedSchemas()	Returnssets a value indicating whether referenced schemas are documented.
boolean	getIncludeSimpleTypes()	property IncludeSimpleTypes
GUID	getInterfaceIID()
boolean	getMultipleOutputFiles()	Returnssets a value indicating whether the output document is split to multiple files.
Enums.SPYDialogAction	getOptionsDialogAction()	property OptionsDialogAction
java.lang.String	getOutputFile()	property OutputFile
Enums.SPYDialogAction	getOutputFileDialogAction()	property OutputFileDialogAction
Enums.SPYSchemaDocumentationFormat	getOutputFormat()	property OutputFormat
COMIDispatchObject	getParent()	property Parent
boolean	getShowAnnotations()	property ShowAnnotations
boolean	getShowAttributes()	property ShowAttributes
boolean	getShowChildren()	property ShowChildren
boolean	getShowDiagram()	property ShowDiagram
boolean	getShowEnumerations()	property ShowEnumerations
boolean	getShowIdentityConstraints()	property ShowIdentityConstraints
boolean	getShowNamespace()	property ShowNamespace
boolean	getShowPatterns()	property ShowPatterns
boolean	getShowProgressBar()	property ShowProgressBar
boolean	getShowProperties()	property ShowProperties
boolean	getShowResult()	property ShowResult
boolean	getShowSingleFacets()	property ShowSingleFacets
boolean	getShowSourceCode()	property ShowSourceCode
boolean	getShowType()	property ShowType
boolean	getShowUsedBy()	property ShowUsedBy
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 i_bInclude)	method IncludeAll
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	setGenerateRelativeLinks(boolean newValue)	Returnssets a value indicating whether links to local files are relative (true) or absolute (false).
void	setIncludeAttributeGroups(boolean newValue)	property IncludeAttributeGroups
void	setIncludeComplexTypes(boolean newValue)	property IncludeComplexTypes
void	setIncludeGlobalAttributes(boolean newValue)	Returnssets a value indicating whether global attributes are documented.
void	setIncludeGlobalElements(boolean newValue)	property IncludeGlobalElements
void	setIncludeGroups(boolean newValue)	property IncludeGroups
void	setIncludeIndex(boolean newValue)	property IncludeIndex
void	setIncludeLocalAttributes(boolean newValue)	Returnssets a value indicating whether local attributes are documented.
void	setIncludeLocalElements(boolean newValue)	property IncludeLocalElements
void	setIncludeRedefines(boolean newValue)	property IncludeRedefines
void	setIncludeReferencedSchemas(boolean newValue)	Returnssets a value indicating whether referenced schemas are documented.
void	setIncludeSimpleTypes(boolean newValue)	property IncludeSimpleTypes
void	setMultipleOutputFiles(boolean newValue)	Returnssets a value indicating whether the output document is split to multiple files.
void	setOptionsDialogAction(Enums.SPYDialogAction newValue)	property OptionsDialogAction
void	setOutputFile(java.lang.String newValue)	property OutputFile
void	setOutputFileDialogAction(Enums.SPYDialogAction newValue)	property OutputFileDialogAction
void	setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue)	property OutputFormat
void	setShowAnnotations(boolean newValue)	property ShowAnnotations
void	setShowAttributes(boolean newValue)	property ShowAttributes
void	setShowChildren(boolean newValue)	property ShowChildren
void	setShowDiagram(boolean newValue)	property ShowDiagram
void	setShowEnumerations(boolean newValue)	property ShowEnumerations
void	setShowIdentityConstraints(boolean newValue)	property ShowIdentityConstraints
void	setShowNamespace(boolean newValue)	property ShowNamespace
void	setShowPatterns(boolean newValue)	property ShowPatterns
void	setShowProgressBar(boolean newValue)	property ShowProgressBar
void	setShowProperties(boolean newValue)	property ShowProperties
void	setShowResult(boolean newValue)	property ShowResult
void	setShowSingleFacets(boolean newValue)	property ShowSingleFacets
void	setShowSourceCode(boolean newValue)	property ShowSourceCode
void	setShowType(boolean newValue)	property ShowType
void	setShowUsedBy(boolean newValue)	property ShowUsedBy
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

property Application

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

property Parent

Throws:

AutomationException

getOutputFile

public java.lang.String getOutputFile() throws AutomationException

property OutputFile

Throws:

AutomationException

setOutputFile

public void setOutputFile(java.lang.String newValue) throws AutomationException

property OutputFile

Throws:

AutomationException

getOutputFormat

public Enums.SPYSchemaDocumentationFormat getOutputFormat() throws AutomationException

property OutputFormat

Throws:

AutomationException

setOutputFormat

public void setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue) throws AutomationException

property OutputFormat

Throws:

AutomationException

getIncludeIndex

public boolean getIncludeIndex() throws AutomationException

property IncludeIndex

Throws:

AutomationException

setIncludeIndex

public void setIncludeIndex(boolean newValue) throws AutomationException

property IncludeIndex

Throws:

AutomationException

getIncludeGlobalElements

public boolean getIncludeGlobalElements() throws AutomationException

property IncludeGlobalElements

Throws:

AutomationException

setIncludeGlobalElements

public void setIncludeGlobalElements(boolean newValue) throws AutomationException

property IncludeGlobalElements

Throws:

AutomationException

getIncludeLocalElements

public boolean getIncludeLocalElements() throws AutomationException

property IncludeLocalElements

Throws:

AutomationException

setIncludeLocalElements

public void setIncludeLocalElements(boolean newValue) throws AutomationException

property IncludeLocalElements

Throws:

AutomationException

getIncludeGroups

public boolean getIncludeGroups() throws AutomationException

property IncludeGroups

Throws:

AutomationException

setIncludeGroups

public void setIncludeGroups(boolean newValue) throws AutomationException

property IncludeGroups

Throws:

AutomationException

getIncludeComplexTypes

public boolean getIncludeComplexTypes() throws AutomationException

property IncludeComplexTypes

Throws:

AutomationException

setIncludeComplexTypes

public void setIncludeComplexTypes(boolean newValue) throws AutomationException

property IncludeComplexTypes

Throws:

AutomationException

getIncludeSimpleTypes

public boolean getIncludeSimpleTypes() throws AutomationException

property IncludeSimpleTypes

Throws:

AutomationException

setIncludeSimpleTypes

public void setIncludeSimpleTypes(boolean newValue) throws AutomationException

property IncludeSimpleTypes

Throws:

AutomationException

getIncludeAttributeGroups

public boolean getIncludeAttributeGroups() throws AutomationException

property IncludeAttributeGroups

Throws:

AutomationException

setIncludeAttributeGroups

public void setIncludeAttributeGroups(boolean newValue) throws AutomationException

property IncludeAttributeGroups

Throws:

AutomationException

getIncludeRedefines

public boolean getIncludeRedefines() throws AutomationException

property IncludeRedefines

Throws:

AutomationException

setIncludeRedefines

public void setIncludeRedefines(boolean newValue) throws AutomationException

property IncludeRedefines

Throws:

AutomationException

getShowDiagram

public boolean getShowDiagram() throws AutomationException

property ShowDiagram

Throws:

AutomationException

setShowDiagram

public void setShowDiagram(boolean newValue) throws AutomationException

property ShowDiagram

Throws:

AutomationException

getShowNamespace

public boolean getShowNamespace() throws AutomationException

property ShowNamespace

Throws:

AutomationException

setShowNamespace

public void setShowNamespace(boolean newValue) throws AutomationException

property ShowNamespace

Throws:

AutomationException

getShowType

public boolean getShowType() throws AutomationException

property ShowType

Throws:

AutomationException

setShowType

public void setShowType(boolean newValue) throws AutomationException

property ShowType

Throws:

AutomationException

getShowChildren

public boolean getShowChildren() throws AutomationException

property ShowChildren

Throws:

AutomationException

setShowChildren

public void setShowChildren(boolean newValue) throws AutomationException

property ShowChildren

Throws:

AutomationException

getShowUsedBy

public boolean getShowUsedBy() throws AutomationException

property ShowUsedBy

Throws:

AutomationException

setShowUsedBy

public void setShowUsedBy(boolean newValue) throws AutomationException

property ShowUsedBy

Throws:

AutomationException

getShowProperties

public boolean getShowProperties() throws AutomationException

property ShowProperties

Throws:

AutomationException

setShowProperties

public void setShowProperties(boolean newValue) throws AutomationException

property ShowProperties

Throws:

AutomationException

getShowSingleFacets

public boolean getShowSingleFacets() throws AutomationException

property ShowSingleFacets

Throws:

AutomationException

setShowSingleFacets

public void setShowSingleFacets(boolean newValue) throws AutomationException

property ShowSingleFacets

Throws:

AutomationException

getShowPatterns

public boolean getShowPatterns() throws AutomationException

property ShowPatterns

Throws:

AutomationException

setShowPatterns

public void setShowPatterns(boolean newValue) throws AutomationException

property ShowPatterns

Throws:

AutomationException

getShowEnumerations

public boolean getShowEnumerations() throws AutomationException

property ShowEnumerations

Throws:

AutomationException

setShowEnumerations

public void setShowEnumerations(boolean newValue) throws AutomationException

property ShowEnumerations

Throws:

AutomationException

getShowAttributes

public boolean getShowAttributes() throws AutomationException

property ShowAttributes

Throws:

AutomationException

setShowAttributes

public void setShowAttributes(boolean newValue) throws AutomationException

property ShowAttributes

Throws:

AutomationException

getShowIdentityConstraints

public boolean getShowIdentityConstraints() throws AutomationException

property ShowIdentityConstraints

Throws:

AutomationException

setShowIdentityConstraints

public void setShowIdentityConstraints(boolean newValue) throws AutomationException

property ShowIdentityConstraints

Throws:

AutomationException

getShowAnnotations

public boolean getShowAnnotations() throws AutomationException

property ShowAnnotations

Throws:

AutomationException

setShowAnnotations

public void setShowAnnotations(boolean newValue) throws AutomationException

property ShowAnnotations

Throws:

AutomationException

getShowSourceCode

public boolean getShowSourceCode() throws AutomationException

property ShowSourceCode

Throws:

AutomationException

setShowSourceCode

public void setShowSourceCode(boolean newValue) throws AutomationException

property ShowSourceCode

Throws:

AutomationException

getShowResult

public boolean getShowResult() throws AutomationException

property ShowResult

Throws:

AutomationException

setShowResult

public void setShowResult(boolean newValue) throws AutomationException

property ShowResult

Throws:

AutomationException

getOptionsDialogAction

public Enums.SPYDialogAction getOptionsDialogAction() throws AutomationException

property OptionsDialogAction

Throws:

AutomationException

setOptionsDialogAction

public void setOptionsDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

property OptionsDialogAction

Throws:

AutomationException

getOutputFileDialogAction

public Enums.SPYDialogAction getOutputFileDialogAction() throws AutomationException

property OutputFileDialogAction

Throws:

AutomationException

setOutputFileDialogAction

public void setOutputFileDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

property OutputFileDialogAction

Throws:

AutomationException

getShowProgressBar

public boolean getShowProgressBar() throws AutomationException

property ShowProgressBar

Throws:

AutomationException

setShowProgressBar

public void setShowProgressBar(boolean newValue) throws AutomationException

property ShowProgressBar

Throws:

AutomationException

includeAll

public void includeAll(boolean i_bInclude) throws AutomationException

method IncludeAll

Throws:

AutomationException

allDetails

public void allDetails(boolean i_bDetailsOn) throws AutomationException

method AllDetails

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

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

getIncludeGlobalAttributes

public boolean getIncludeGlobalAttributes() throws AutomationException

Returnssets a value indicating whether global attributes are documented.

Throws:

AutomationException

setIncludeGlobalAttributes

public void setIncludeGlobalAttributes(boolean newValue) throws AutomationException

Returnssets a value indicating whether global attributes are documented.

Throws:

AutomationException

getIncludeLocalAttributes

public boolean getIncludeLocalAttributes() throws AutomationException

Returnssets a value indicating whether local attributes are documented.

Throws:

AutomationException

setIncludeLocalAttributes

public void setIncludeLocalAttributes(boolean newValue) throws AutomationException

Returnssets a value indicating whether local attributes are documented.

Throws:

AutomationException

getIncludeReferencedSchemas

public boolean getIncludeReferencedSchemas() throws AutomationException

Returnssets a value indicating whether referenced schemas are documented.

Throws:

AutomationException

setIncludeReferencedSchemas

public void setIncludeReferencedSchemas(boolean newValue) throws AutomationException

Returnssets a value indicating whether referenced schemas are documented.

Throws:

AutomationException

getMultipleOutputFiles

public boolean getMultipleOutputFiles() throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

Throws:

AutomationException

setMultipleOutputFiles

public void setMultipleOutputFiles(boolean newValue) throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

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

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

getGenerateRelativeLinks

public boolean getGenerateRelativeLinks() throws AutomationException

Returnssets a value indicating whether links to local files are relative (true) or absolute (false).

Throws:

AutomationException

setGenerateRelativeLinks

public void setGenerateRelativeLinks(boolean newValue) throws AutomationException

Returnssets a value indicating whether links to local files are relative (true) or absolute (false).

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