Difference between revisions of "TabulationTextStyle class"

From Catglobe Wiki
Jump to: navigation, search
Line 2: Line 2:
 
|Name=<nowiki>TabulationTextStyle</nowiki>
 
|Name=<nowiki>TabulationTextStyle</nowiki>
 
|Description=<nowiki>Styles for use on a portion of text</nowiki>
 
|Description=<nowiki>Styles for use on a portion of text</nowiki>
|Constructors=
+
|InheritsFrom=object|Constructors=
 
{{CGscriptConstructors_Template|Description=<nowiki>Create a new TabulationTextStyle</nowiki>}}
 
{{CGscriptConstructors_Template|Description=<nowiki>Create a new TabulationTextStyle</nowiki>}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Bold</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Bold to string.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Bold</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Bold to string.</nowiki>}}
Line 13: Line 13:
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Italic</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Italic to string.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Italic</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Italic to string.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Underline</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Underline to string.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Underline</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Underline to string.</nowiki>}}
 
}}
 
}}

Revision as of 08:18, 2 July 2020

TabulationTextStyle



Styles for use on a portion of text

Parent class

Inherits from object

Constructors

  • () - Create a new TabulationTextStyle

Methods

  • (From object) string ToString() - The string representation of the object.

Properties

  • bool Bold { get; set; } - Get/Set Bold to string.
  • Color Color { get; set; } - Get/Set Color of string.
  • string FontFace { get; set; } - Get/Set FontFace of string.
  • int FontSize { get; set; } - Get/Set FontSize of string in points. Must be 1-400 points
  • bool Italic { get; set; } - Get/Set Italic to string.
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • bool Underline { get; set; } - Get/Set Underline to string.


Relevant classes and function : TabulationParagraphStyle, TabulationParagraph, Tabulation_addParagraph

Examples

TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
paragraphStyle.Alignment = "center"; //left, right, center.

//TabulationTextStyle 
TabulationTextStyle textStyle = new TabulationTextStyle();
textStyle.Color = Color_getByName("red"); //Takes a color array-
//textStyle.Color = Color_getByRGB(255,0,0); // can also be set from rgb.
//textStyle.Color = new Color("red",false); // can also be set by Color object
textStyle.FontFace = "Bariol Regular";
textStyle.FontSize = 40; //1-399
textStyle.Bold = false;
textStyle.Italic = false;
textStyle.Underline = false;

TabulationParagraph paragraph = new TabulationParagraph(paragraphStyle);
paragraph.AddPortion("Some text", textStyle);

Tabulation_addParagraph(paragraph);