Difference between revisions of "TabulationBulletNumeric class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=TabulationBulletNumeric |Description=Settings for Numericbullets on paragraph |Constructors= {{CGscriptConstructors_Template|Description=Create ...")
 
Line 15: Line 15:
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
}}
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
 +
<source lang="javascript">
 +
TabulationBulletDot bulletNum = new TabulationBulletDot();
 +
//For all bullet types
 +
bulletdot.Level = 1;//Defines what level of the list we want the paragraph.
 +
bulletdot.Color = Color_getByName("green");
 +
bulletdot.IsInList = true;//Defines if the bullet point is in a list.
 +
 +
bulletNum.StartNumber = 1;//The number the list should start with. Must only be set for the first element.
 +
bulletNum.IsPrefixed = false; //Indicates if the list in the pdf shoud prefix the number with higher levels ie: true: 1.1.2. false: 2.
 +
 +
paragraphStyle.SetBulletSetting(bulletNum);
 +
Tabulation_addParagraph(new TabulationParagraph(paragraphStyle,"A numbered list item",textStyle));

Revision as of 16:47, 21 June 2016

TabulationBulletNumeric



Settings for Numericbullets on paragraph

Constructors

  • () - Create a new BulletSetting for a Numeric list

Methods

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

Properties

  • array Color { get; set; } - Get/Set Color of bullets and numbers
  • bool IsInList { get; set; } - Get/Set if the paragraph is used in a list.
  • bool IsPrefixed { get; set; } - Get/Set if the number is prefixed with parent numbers.
  • int Level { get; set; } - Get/Set Level of nesting of list element
  • string ObjectTypeName { get; } - The name of the type of object.
  • int StartNumber { get; set; } - Get/Set startnumber for this sequence - set to -1 for not set
  • TypeInformation TypeInformation { get; } - Get information about this class.

Examples

<source lang="javascript"> TabulationBulletDot bulletNum = new TabulationBulletDot(); //For all bullet types bulletdot.Level = 1;//Defines what level of the list we want the paragraph. bulletdot.Color = Color_getByName("green"); bulletdot.IsInList = true;//Defines if the bullet point is in a list.

bulletNum.StartNumber = 1;//The number the list should start with. Must only be set for the first element. bulletNum.IsPrefixed = false; //Indicates if the list in the pdf shoud prefix the number with higher levels ie: true: 1.1.2. false: 2.

paragraphStyle.SetBulletSetting(bulletNum); Tabulation_addParagraph(new TabulationParagraph(paragraphStyle,"A numbered list item",textStyle));