asposediagram.api

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
methodgetAsianFont()
method
           Specifies the ID number of the font used to format text containing Asian characters.
methodgetAsianFontName()
method
           It specified the asian font name of the font used to format the text.It is using for visio 2013
methodgetCase()
method
setCase(value)
           Determines the case of a shape's text.
methodgetColor()
method
setColor(value)
           When contained in a Char element, the Color element.
methodgetColorTrans()
method
           Determines the degree of transparency for a layer or shape's text color, from 0 (completely opaque) to 1 (completely transparent).
methodgetComplexScriptFont()
method
           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.
methodgetComplexScriptFontName()
method
           It specified the ComplexScript font name of the font used to format the text.It is using for visio 2013
methodgetComplexScriptSize()
method
           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.
methodgetDblUnderline()
method
           Specifies whether the range of text has a double underline below it.
methodgetDel()
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.
methodgetDoubleStrikethrough()
method
           Determines whether text is formatted as double strikethrough.
methodgetFont()
method
setFont(value)
           Specifies the ID number of the font used to format the text.
methodgetFontName()
method
           It specified the font name of the font used to format the text.It is using for visio 2013
methodgetFontScale()
method
           Specifies the font width.
methodgetHighlight()
method
           It specified highlight.
methodisBold()
Indicating whether the font is bold.
methodisDoubleStrikethrough()
Indicating whether the font is doubleStrikethrough.
methodisDoubleUnderline()
Indicating whether the font is double underline.
methodisItalic()
Indicating whether the font is italic.
methodisStrikethrough()
Indicating whether the font is strikethrough.
methodisSubscript()
Indicating whether the font is subscript.
methodisSuperscript()
Indicating whether the font is superscript.
methodisUnderline()
Indicating whether the font is underline.
methodgetIX()
method
setIX(value)
           The zero-based index of the element within its parent element.
methodgetLangID()
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.
methodgetLetterspace()
method
           Specifies the amount of space between two or more characters. Space can be added or subtracted in 1/20th point increments.
methodgetLocale()
method
setLocale(value)
           It specified the locale of the text run for spell-checking purposes.
methodgetLocalizeFont()
method
           Specifies whether the shape text should be localized (translated into another language).
methodgetOverline()
method
           Specifies whether the text has a line above it.
methodgetPerpendicular()
method
           It specified whether a text field appears perpendicular to the other text in a text block.
methodgetPos()
method
setPos(value)
           Specifies the position of the shape's text relative to the baseline.
methodgetRTLText()
method
setRTLText(value)
           Determines if the text direction of the current character run is left to right or right to left.
methodgetSize()
method
setSize(value)
           Specifies the size of the text in the shape's text block.
methodgetStrikethru()
method
           Specifies whether the text is formatted as strikethrough.
methodgetStyle()
method
setStyle(value)
           Specifies the character formatting applied to a range of text in the shape's text block.
methodgetUseVertical()
method
           Determines whether the character run is vertical or horizontal.
 
Method Summary
methoddeepClone()
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: