UModelAPI - IGenerateDocumentationDlg

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  UModel Programmer's Reference > UModel API Reference > UModel API >

UModelAPI - IGenerateDocumentationDlg

Interface IGenerateDocumentationDlg

diagram

UModelAPI_p58.png

hierarchy

UModelAPI_p59.png

typedElements

Interface IDialogs

Operation

GenerateDocumentationDlg

Interface IDocument

Operation

GenerateDocumentation

 

Operation IGenerateDocumentationDlg::CreateFolderForDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Associations

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_BoundElements

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Constraints

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Diagram

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Documentation

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_DocumentationAsHTML

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Generals

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_HierarchyDiagram

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_HierarchyDiagramExpandItemsOnlyOnce

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_HierarchyDiagramNestingDepthDown

parameter

name

direction

type

type modifier

multiplicity

default

return

return

int

 

 

 

 

Operation IGenerateDocumentationDlg::Details_HierarchyDiagramNestingDepthUp

parameter

name

direction

type

type modifier

multiplicity

default

return

return

int

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Hyperlinks

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_ImplementedInterfaces

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_OperationParameters

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_OwnedDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_OwnedMembers

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Owner

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Properties

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_SelectAll

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Details_SelectNone

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Details_ShownOnDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_SourceTargetOfRelations

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_Specifics

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_TemplateParameters

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_TemplateParameterSubstitutions

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Details_TypedElements

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::DiagramImageFormat

parameter

name

direction

type

type modifier

multiplicity

default

return

return

ENUMOutputImageFormat

 

 

 

 

Operation IGenerateDocumentationDlg::EmbedCSSinHTML

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::EmbedDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_GetFace

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

string

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_GetSize

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

int

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_GetTextColor

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

int

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_IsBold

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_IsItalic

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_IsUnderline

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetBold

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

bVal

in

bool

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetDefaults

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetFace

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

strNewVal

in

string

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetItalic

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

bVal

in

bool

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetSize

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

nNewVal

in

int

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetTextColor

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

nNewVal

in

int

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Fonts_SetUnderline

parameter

name

direction

type

type modifier

multiplicity

default

nSetting

in

ENUMDocumentationFontSetting

 

 

 

bVal

in

bool

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::GenerateLinksToLocalFiles

parameter

name

direction

type

type modifier

multiplicity

default

return

return

ENUMDocumentationFilePathKind

 

 

 

 

Operation IGenerateDocumentationDlg::Include_Diagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

IKindSelectionList

 

 

 

 

Operation IGenerateDocumentationDlg::Include_Elements

parameter

name

direction

type

type modifier

multiplicity

default

return

return

IKindSelectionList

 

 

 

 

Operation IGenerateDocumentationDlg::Include_IncludedPredefinedSubprojects

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Include_IncludedSubprojects

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Include_Index

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Include_NamedElementsOnly

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectAllDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectAllElements

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectAllKindsOf

parameter

name

direction

type

type modifier

multiplicity

default

strKindName

in

string

 

 

 

bVal

in

bool

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectDefaults

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectKind

parameter

name

direction

type

type modifier

multiplicity

default

strKindName

in

string

 

 

 

bVal

in

bool

 

 

 

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectNoDiagrams

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_SelectNoElements

parameter

name

direction

type

type modifier

multiplicity

default

return

return

void

 

 

 

 

Operation IGenerateDocumentationDlg::Include_UnknownExternals

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::OutputFormat

parameter

name

direction

type

type modifier

multiplicity

default

return

return

ENUMDocumentationOutputFormat

 

 

 

 

Operation IGenerateDocumentationDlg::ShowResultFileAfterGeneration

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::SplitOutputToMultipleFiles

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

Operation IGenerateDocumentationDlg::SPSFile

parameter

name

direction

type

type modifier

multiplicity

default

return

return

string

 

 

 

 

Operation IGenerateDocumentationDlg::UseFixedDesign

parameter

name

direction

type

type modifier

multiplicity

default

return

return

bool

 

 

 

 

 

 

UML documentation generated by UModel UML Editor http://www.altova.com/umodel

Wed Mar 6 07:10:42 2019


© 2019 Altova GmbH