asposediagram.api

Classes

Exceptions

DiagramException

Constants

Class Char

Contains the formatting attributes for the shape's text, such as font, color, text style, case, position relative to the baseline, and point size.

Constructor Summary
`Char()` Constructor.

Property Getters/Setters Summary
`method`	`getAsianFont()`
`method`	`setAsianFont(value)`
	Specifies the ID number of the font used to format text containing Asian characters.
`method`	`getAsianFontName()`
`method`	`setAsianFontName(value)`
	It specified the asian font name of the font used to format the text.It is using for visio 2013
`method`	`getCase()`
`method`	`setCase(value)`
	Determines the case of a shape's text.
`method`	`getColor()`
`method`	`setColor(value)`
	When contained in a Char element, the Color element.
`method`	`getColorTrans()`
`method`	`setColorTrans(value)`
	Determines the degree of transparency for a layer or shape's text color, from 0 (completely opaque) to 1 (completely transparent).
`method`	`getComplexScriptFont()`
`method`	`setComplexScriptFont(value)`
	Contains the number of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.
`method`	`getComplexScriptFontName()`
`method`	`setComplexScriptFontName(value)`
	It specified the ComplexScript font name of the font used to format the text.It is using for visio 2013
`method`	`getComplexScriptSize()`
`method`	`setComplexScriptSize(value)`
	The size of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.
`method`	`getDblUnderline()`
`method`	`setDblUnderline(value)`
	Specifies whether the range of text has a double underline below it.
`method`	`getDel()`
`method`	`setDel(value)`
	A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
`method`	`getDoubleStrikethrough()`
`method`	`setDoubleStrikethrough(value)`
	Determines whether text is formatted as double strikethrough.
`method`	`getFont()`
`method`	`setFont(value)`
	Specifies the ID number of the font used to format the text.
`method`	`getFontName()`
`method`	`setFontName(value)`
	It specified the font name of the font used to format the text.It is using for visio 2013
`method`	`getFontScale()`
`method`	`setFontScale(value)`
	Specifies the font width.
`method`	`getHighlight()`
`method`	`setHighlight(value)`
	It specified highlight.
`method`	`isBold()`
	Indicating whether the font is bold.
`method`	`isDoubleStrikethrough()`
	Indicating whether the font is doubleStrikethrough.
`method`	`isDoubleUnderline()`
	Indicating whether the font is double underline.
`method`	`isItalic()`
	Indicating whether the font is italic.
`method`	`isStrikethrough()`
	Indicating whether the font is strikethrough.
`method`	`isSubscript()`
	Indicating whether the font is subscript.
`method`	`isSuperscript()`
	Indicating whether the font is superscript.
`method`	`isUnderline()`
	Indicating whether the font is underline.
`method`	`getIX()`
`method`	`setIX(value)`
	The zero-based index of the element within its parent element.
`method`	`getLangID()`
`method`	`setLangID(value)`
	Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered. For a list of languages supported by Microsoft Office applications and their corresponding language IDs, see the DocLangID element.
`method`	`getLetterspace()`
`method`	`setLetterspace(value)`
	Specifies the amount of space between two or more characters. Space can be added or subtracted in 1/20th point increments.
`method`	`getLocale()`
`method`	`setLocale(value)`
	It specified the locale of the text run for spell-checking purposes.
`method`	`getLocalizeFont()`
`method`	`setLocalizeFont(value)`
	Specifies whether the shape text should be localized (translated into another language).
`method`	`getOverline()`
`method`	`setOverline(value)`
	Specifies whether the text has a line above it.
`method`	`getPerpendicular()`
`method`	`setPerpendicular(value)`
	It specified whether a text field appears perpendicular to the other text in a text block.
`method`	`getPos()`
`method`	`setPos(value)`
	Specifies the position of the shape's text relative to the baseline.
`method`	`getRTLText()`
`method`	`setRTLText(value)`
	Determines if the text direction of the current character run is left to right or right to left.
`method`	`getSize()`
`method`	`setSize(value)`
	Specifies the size of the text in the shape's text block.
`method`	`getStrikethru()`
`method`	`setStrikethru(value)`
	Specifies whether the text is formatted as strikethrough.
`method`	`getStyle()`
`method`	`setStyle(value)`
	Specifies the character formatting applied to a range of text in the shape's text block.
`method`	`getUseVertical()`
`method`	`setUseVertical(value)`
	Determines whether the character run is vertical or horizontal.

Method Summary
`method`	`deepClone()`
`method`	Creates deep copy of this instance.

- Constructor Detail
  - Char
```
Char()
```
    Constructor.
- Property Getters/Setters Detail
  - getIX/setIX : int
```
int getIX() / setIX(value)
```
    The zero-based index of the element within its parent element.
  - getDel/setDel : int
```
int getDel() / setDel(value)
```
    A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
  - getFont/setFont : IntValue
```
IntValue getFont() / setFont(value)
```
    Specifies the ID number of the font used to format the text.
  - getFontName/setFontName : StrValue
```
StrValue getFontName() / setFontName(value)
```
    It specified the font name of the font used to format the text.It is using for visio 2013
  - getColor/setColor : ColorValue
```
ColorValue getColor() / setColor(value)
```
    When contained in a Char element, the Color element.
  - getStyle/setStyle : Style
```
Style getStyle() / setStyle(value)
```
    Specifies the character formatting applied to a range of text in the shape's text block.
  - getCase/setCase : Case
```
Case getCase() / setCase(value)
```
    Determines the case of a shape's text.
  - getPos/setPos : Pos
```
Pos getPos() / setPos(value)
```
    Specifies the position of the shape's text relative to the baseline.
  - getFontScale/setFontScale : DoubleValue
```
DoubleValue getFontScale() / setFontScale(value)
```
    Specifies the font width.
  - getLocale/setLocale : StrValue
```
StrValue getLocale() / setLocale(value)
```
    It specified the locale of the text run for spell-checking purposes.
  - getSize/setSize : DoubleValue
```
DoubleValue getSize() / setSize(value)
```
    Specifies the size of the text in the shape's text block.
  - getDblUnderline/setDblUnderline : BoolValue
```
BoolValue getDblUnderline() / setDblUnderline(value)
```
    Specifies whether the range of text has a double underline below it.
  - getOverline/setOverline : BoolValue
```
BoolValue getOverline() / setOverline(value)
```
    Specifies whether the text has a line above it.
  - getHighlight/setHighlight : BoolValue
```
BoolValue getHighlight() / setHighlight(value)
```
    It specified highlight.
  - getPerpendicular/setPerpendicular : StrValue
```
StrValue getPerpendicular() / setPerpendicular(value)
```
    It specified whether a text field appears perpendicular to the other text in a text block.
  - getStrikethru/setStrikethru : BoolValue
```
BoolValue getStrikethru() / setStrikethru(value)
```
    Specifies whether the text is formatted as strikethrough.
  - getDoubleStrikethrough/setDoubleStrikethrough : BoolValue
```
BoolValue getDoubleStrikethrough() / setDoubleStrikethrough(value)
```
    Determines whether text is formatted as double strikethrough.
  - getRTLText/setRTLText : BoolValue
```
BoolValue getRTLText() / setRTLText(value)
```
    Determines if the text direction of the current character run is left to right or right to left.
  - getUseVertical/setUseVertical : BoolValue
```
BoolValue getUseVertical() / setUseVertical(value)
```
    Determines whether the character run is vertical or horizontal.
  - getLetterspace/setLetterspace : DoubleValue
```
DoubleValue getLetterspace() / setLetterspace(value)
```
    Specifies the amount of space between two or more characters. Space can be added or subtracted in 1/20th point increments.
  - getColorTrans/setColorTrans : DoubleValue
```
DoubleValue getColorTrans() / setColorTrans(value)
```
    Determines the degree of transparency for a layer or shape's text color, from 0 (completely opaque) to 1 (completely transparent).
  - getAsianFont/setAsianFont : IntValue
```
IntValue getAsianFont() / setAsianFont(value)
```
    Specifies the ID number of the font used to format text containing Asian characters.
  - getAsianFontName/setAsianFontName : StrValue
```
StrValue getAsianFontName() / setAsianFontName(value)
```
    It specified the asian font name of the font used to format the text.It is using for visio 2013
  - getLocalizeFont/setLocalizeFont : LocalizeFont
```
LocalizeFont getLocalizeFont() / setLocalizeFont(value)
```
    Specifies whether the shape text should be localized (translated into another language).
  - isDoubleUnderline : boolean
```
boolean isDoubleUnderline()
```
    Indicating whether the font is double underline.
  - isSubscript : boolean
```
boolean isSubscript()
```
    Indicating whether the font is subscript.
  - isSuperscript : boolean
```
boolean isSuperscript()
```
    Indicating whether the font is superscript.
  - isStrikethrough : boolean
```
boolean isStrikethrough()
```
    Indicating whether the font is strikethrough.
  - isDoubleStrikethrough : boolean
```
boolean isDoubleStrikethrough()
```
    Indicating whether the font is doubleStrikethrough.
  - isUnderline : boolean
```
boolean isUnderline()
```
    Indicating whether the font is underline.
  - isItalic : boolean
```
boolean isItalic()
```
    Indicating whether the font is italic.
  - isBold : boolean
```
boolean isBold()
```
    Indicating whether the font is bold.
  - getComplexScriptSize/setComplexScriptSize : DoubleValue
```
DoubleValue getComplexScriptSize() / setComplexScriptSize(value)
```
    The size of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.
  - getComplexScriptFont/setComplexScriptFont : IntValue
```
IntValue getComplexScriptFont() / setComplexScriptFont(value)
```
    Contains the number of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.
  - getComplexScriptFontName/setComplexScriptFontName : StrValue
```
StrValue getComplexScriptFontName() / setComplexScriptFontName(value)
```
    It specified the ComplexScript font name of the font used to format the text.It is using for visio 2013
  - getLangID/setLangID : IntValue
```
IntValue getLangID() / setLangID(value)
```
    Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered. For a list of languages supported by Microsoft Office applications and their corresponding language IDs, see the DocLangID element.
- Method Detail
  - deepClone
```
Object deepClone()
```
    Creates deep copy of this instance.
    Returns:

asposediagram.api

Classes

Exceptions

Constants

Class Char

Constructor Detail

Char

Property Getters/Setters Detail

getIX/setIX : int

getDel/setDel : int

getFont/setFont : IntValue

getFontName/setFontName : StrValue

getColor/setColor : ColorValue

getStyle/setStyle : Style

getCase/setCase : Case

getPos/setPos : Pos

getFontScale/setFontScale : DoubleValue

getLocale/setLocale : StrValue

getSize/setSize : DoubleValue

getDblUnderline/setDblUnderline : BoolValue

getOverline/setOverline : BoolValue

getHighlight/setHighlight : BoolValue

getPerpendicular/setPerpendicular : StrValue

getStrikethru/setStrikethru : BoolValue

getDoubleStrikethrough/setDoubleStrikethrough : BoolValue

getRTLText/setRTLText : BoolValue

getUseVertical/setUseVertical : BoolValue

getLetterspace/setLetterspace : DoubleValue

getColorTrans/setColorTrans : DoubleValue

getAsianFont/setAsianFont : IntValue

getAsianFontName/setAsianFontName : StrValue

getLocalizeFont/setLocalizeFont : LocalizeFont

isDoubleUnderline : boolean

isSubscript : boolean

isSuperscript : boolean

isStrikethrough : boolean

isDoubleStrikethrough : boolean

isUnderline : boolean

isItalic : boolean

isBold : boolean

getComplexScriptSize/setComplexScriptSize : DoubleValue

getComplexScriptFont/setComplexScriptFont : IntValue

getComplexScriptFontName/setComplexScriptFontName : StrValue

getLangID/setLangID : IntValue

Method Detail

deepClone