Difference between revisions of "Tabulation addParagraph"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty |Parameters= |Name=Paragraph|ConstantType=Object }}")
 
Line 3: Line 3:
 
|Name=Paragraph|ConstantType=Object
 
|Name=Paragraph|ConstantType=Object
 
}}
 
}}
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
 +
<source lang="javascript">
 +
//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);
 +
</source>

Revision as of 16:53, 21 June 2016

Paragraph


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

Syntax

Paragraph(array emails);

Arguments

emails: array. Array of emails.

There are 2 ways of using array emails:

The first way: Each email is an EmailBlacklist object

The second way: Each email is an array with pair of email and comment {email, comment}

Return type

Number. Number of emails added to Blacklist

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);