1. Home
  2. Support
  3. Documentations
  4. BP-VA User's Guide
  5. Part VII. Report generation
  6. Chapter 6. Report composer templates
  7. Text and break

Text and break

<StaticText>

Description

<StaticText> is a construct which enables you to insert your own text into a report, at the position where <StatcText> is processed. You can add your text with custom formats.

Attributes

Name Description/Usage Required?
content : string The text to add.
 Optional
isBold : boolean Set the text to bold.
 Optional
isItalic : boolean Set the text italic. Optional
isUnderline : boolean Set the text to underline. Optional
isSuperscript : boolean Set the text to superscript. Optional
fontFamily : string = Times New Roman Specify the name of font to apply to the text. Optional
alignment = left

{left | center | right}		 Set the alignment of text. Optional
fontSize : integer = 12 Set the font size. Optional
style : string Set the name of style. You can add and edit style in report diagram. Optional
numberingLevel : short Detemine the Numbering Level if the text is showing as a number or bullet list.
 Optional
foreColor = color The color of text. Optional
indentation : double Determine the left margin of text.
 Optional
hyperlink : boolean = false Specify whether the text is a hyperlink or not. If true, the text will be linkable. Optional
Supported attributes for <StaticText>

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Say Hello" description = "/" type = "text" default = "false"/>
    <ProjectBaseInitiationBlock>
        <StaticText content="Hello!" />
    </ProjectBaseInitiationBlock>
</Template>

<StringPropertyText>

Description

<StringPropertyText> is the most commonly used construct in a report template document. It is used to extract a string property from model element (e.g. name of a class) and print it to report.

Attributes

Name Description/Usage Required?
propertyText : string Deprecated. Replaced by @property. Optional
isIgnoreHTMLFontSize : boolean = false Ignore the font size on the HTML text.
Optional
isIgnoreHTMLFontFamily : boolean = false Ignore the font selection of the HTML text Optional
forcePlainText : boolean Force HTML text to show as plain text by removing formatting, if any. Optional
defaultValue : string The text to show when the value of property has not ever been specified. Optional
property : string
 The name of string property to retrieve from model element.
 Required
isBold : boolean Set the text to bold.
 Optional
isItalic : boolean
 Set the text italic.
 Optional
fontFamily : string = Times New Roman
 Specify the name of font to apply to the text.
 Optional
alignment = left

{left | center | right}
 Set the alignment of text.
 Optional
fontSize : integer = 12
 Set the font size.
 Optional
style : string
 Set the name of style. You can add and edit style in report diagram.
 Optional
numberingLevel : short
 Detemine the Numbering Level if the text is showing as a number or bullet list. Optional
foreColor = color
 The color of text. Optional
indentation : double
 Determine the left margin of text. Optional
hyperlink : boolean = false
 Specify whether the text is a hyperlink or not. If true, the text will be linkable. Optional
Supported attributes for <StringPropertyText>

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Name of use cases" description = "/" type = "text" default = "false"/>
    <ElementBaseInitiationBlock>
        <StringPropertyText propertyText="name/>
    </ElementBaseInitiationBlock>
</Template>

<IntPropertyText>

Description

<IntPropertyText> is a construct which enables you to extract an integer property from model element (e.g. length of an entity column) and print it to report.

Attributes

Name Description/Usage Required?
propertyText : string
 Deprecated. Replaced by @property.
 Optional
isIgnoreHTMLFontSize : boolean = false
 Ignore the font size on the HTML text. Optional
property : string
 The name of integer property to retrieve from model element.
 Required
isBold : boolean Set the text to bold.
 Optional
isItalic : boolean
 Set the text italic.
 Optional
fontFamily : string = Times New Roman
 Specify the name of font to apply to the text.
 Optional
alignment = left

{left | center | right}
 Set the alignment of text.
 Optional
fontSize : integer = 12
 Set the font size.
 Optional
style : string
 Set the name of style. You can add and edit style in report diagram.
 Optional
numberingLevel : short
 Detemine the Numbering Level if the text is showing as a number or bullet list. Optional
foreColor = color
 The color of text. Optional
Supported attributes for <IntPropertyText>

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Entity columns" description = "/" type = "text" default = "false"/>
    <ElementBaseInitiationBlock>
        <IterationBlock elementType = "DBColumn">
            <IntPropertyText propertyText = "length"/>
        </IterationBlock>
    </ElementBaseInitiationBlock>
</Template>

<BooleanPropertyText>

Description

<BooleanPropertyText> is a construct which enables you to extract a boolean property (i.e. true/false) from model element (e.g. abstract of a class) and print it to report.

Attributes

Name Description/Usage Required?
propertyText : string
 Deprecated. Replaced by @property.
 Optional
property : string
 The name of boolean property to retrieve from model element.
 Required
isBold : boolean Set the text to bold.
 Optional
isItalic : boolean
 Set the text italic.
 Optional
fontFamily : string = Times New Roman
 Specify the name of font to apply to the text.
 Optional
alignment = left

{left | center | right}
 Set the alignment of text.
 Optional
fontSize : integer = 12
 Set the font size.
 Optional
style : string
 Set the name of style. You can add and edit style in report diagram.
 Optional
numberingLevel : short
 Detemine the Numbering Level if the text is showing as a number or bullet list. Optional
foreColor = color
 The color of text. Optional
Supported attributes for <BooleanPropertyText>

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Is class abstract?" description = "/" type = "text" default = "false"/>
    <ElementBaseInitiationBlock>
        <StaticText content = "Abstract?" style = "Row caption 1"/>
        <BooleanPropertyText propertyText = "abstract"/>
    </ElementBaseInitiationBlock>
</Template>

<ParagraphBreak>

Description

<ParagraphBreak> is a construct which enables you to add a break in report to separate text into paragraphs. <ParagraphBreak> does not carry any text.

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Two paragraphs" description = "/" type = "text" default = "false"/>
    <ElementBaseInitiationBlock>
        <StaticText content = "Paragraph 1" style = "Row caption 1"/>
        <ParagraphBreak>
        <StaticText content = "Paragraph 2" style = "Row caption 1"/>
    </ElementBaseInitiationBlock>
</Template>

<PageBreak>

Description

<PageBreak> is a construct which enables you to insert a new page at where <PageBreak> is processed.

Sample template fragment

<Template>
    <TemplateInformationHeader name = "Two pages" description = "/" type = "text" default = "false"/>
    <ElementBaseInitiationBlock>
        <StaticText content = "Page 1" style = "Row caption 1"/>
        <ParagraphBreak>
        <StaticText content = " Page 2" style = "Row caption 1"/>
    </ElementBaseInitiationBlock>
</Template>
 
6. Reading model - Model/diagram element Table of Contents 8. Table
 

Product

Try this feature with

Business Process Visual ARCHITECT

Technical Support

Have technical issues or suggestions? Please contact Visual Paradigm Support Team.

Sales Support

Have questions related to registration, licensing or payment? Feel free to contact Visual Paradigm Sales Team.

Discussion Forum

Share your suggestions of opinions at VP Discussion Forum.

 
  1. Home
  2. Support
  3. Documentations
  4. BP-VA User's Guide
  5. Part VII. Report generation
  6. Chapter 6. Report composer templates
  7. Text and break