Difference between revisions of "Tabulation addParagraph"

From Catglobe Wiki
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
==== Tabulation_addParagraph ====
 
==== Tabulation_addParagraph ====
  
Adds an image to the report
+
Adds an paragraph to the report
  
 
'''Syntax'''
 
'''Syntax'''
Line 15: Line 15:
  
 
*[[TabulationParagraph class|''TabulationParagraph'']]
 
*[[TabulationParagraph class|''TabulationParagraph'']]
 
 
 
  
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
Line 57: Line 54:
 
Tabulation_addParagraph(paragraph2);
 
Tabulation_addParagraph(paragraph2);
 
</source>
 
</source>
 +
[[category:Diagram/report generating CGScript functions]]
 +
 +
 +
{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''
 +
 +
'''Availability'''
 +
 +
Version 6.0

Latest revision as of 09:44, 24 June 2016

Paragraph


Please write a description and submit to code to autogen it next time

Syntax

Paragraph();

Return type

Empty

Tabulation_addParagraph

Adds an paragraph to the report

Syntax

Tabulation_addParagraph(TabulationParagraph)

Arguments

Examples

//Styling of paragraph 
TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
paragraphStyle.Alignment = "center"; //left, right, center.
paragraphStyle.MarginTopPoints = 10; //1-399
paragraphStyle.MarginLeftPoints = 10;//1-399
 
//Styling of portions
TabulationTextStyle textStyle = new TabulationTextStyle();
textStyle.Color = Color_getByName("red"); //Takes a color array-
textStyle.Color = Color_getByRGB(0,0,0); // can also be set from rgb.
textStyle.FontFace = "Bariol Regular";
textStyle.FontSize = 40; //1-399
textStyle.Bold = false;
textStyle.Italic = false;
textStyle.Underline = false;
 
//Use Tabulation_getAvailableFonts(); to find available fonts
Tabulation_getAvailableFonts();
 
//Create the paragraph
TabulationParagraph paragraph = new TabulationParagraph(paragraphStyle); //It needs the paragraphStyle defined above.
//The paragraph contains portions of text
 //Each portion can be styled individually with a TabulationTextStyle
paragraph.AddPortion("Some text", textStyle);
 
//A paragraph can also be instatiated with portion and portion style in constructor
TabulationParagraph paragraph2 = new TabulationParagraph(paragraphStyle, "Some text ", textStyle);
 
//It is also possible to add hyperlinks
paragraph2.AddLink("CatGlobe", "http://catglobe.com", textStyle);
 
//Add the paragraphs to the report
Tabulation_addParagraph(paragraph);
Tabulation_addParagraph(paragraph2);


Note Note: This function should be paired with function Tabulation_setShowResultAsPdf.

Availability

Version 6.0