Catglobe Wiki - User contributions [en]

TabulationBulletNumeric class

2016-07-01T07:37:38Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=<nowiki>TabulationBulletNumeric</nowiki>
|Description=<nowiki>Settings for Numericbullets on paragraph</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new BulletSetting for a Numeric list</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Color of bullets and numbers</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPrefixed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the number is prefixed with parent numbers.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Level</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Level of nesting of list element</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>StartNumber</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set startnumber for this sequence - set to -1 for not set</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationBulletNumeric bulletNum = new TabulationBulletNumeric();
//For all bullet types
bulletNum.Level = 1;//Defines what level of the list we want the paragraph.
bulletNum.Color = Color_getByName("green");
bulletNum.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));</source>

TabulationBulletDot class

2016-07-01T07:36:58Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=<nowiki>TabulationBulletDot</nowiki>
|Description=<nowiki>Settings for Dotbullets on paragraph</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new Bullet Setting for list with Dots</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>BulletType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set bulletType number 1-7. Find styles on http://www.aspose.com/docs/display/pdfnet/use+system+defined+bullets</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Color of bullets and numbers</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Level</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Level of nesting of list element</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>}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationBulletDot bulletdot = 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.
//For dot bullettype
bulletdot.BulletType = 2;
</source>

Tabulation setStartingPageNumber

2016-06-30T09:45:14Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_setStartingPageNumber ====

Set the starting page number for the PDF report.

'''Syntax'''

Tabulation_setStartingPageNumber(''8'')

'''Arguments''' int pagenumber

=== '''Examples''' ===

<source lang="javascript">

//Starting page number of the PDF report can be set:
//Needs a DCS

Tabulation_setStartingPageNumber(8);
</source>

 {{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''
''The pagenumber can be shown in the pdf by inserting $p in a paragraph. $P (capital P) shows the total number of pages.

'''Availability'''

Version 6.0

Tabulation setStartingPageNumber

2016-06-30T07:39:02Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_setStartingPageNumber====

Set the starting page number for the PDF report.

'''Syntax'''

Tabulation_setStartingPageNumber(''8'')

'''Arguments''' int pagenumber

=== '''Examples''' ===

<source lang="javascript">

//Starting page number of the PDF report can be set:
//Needs a DCS

Tabulation_setStartingPageNumber(8);
</source>

 {{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

Version 6.0

TabulationBulletNumeric class

2016-06-30T07:27:24Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=TabulationBulletNumeric
|Description=Settings for Numericbullets on paragraph
|Constructors=
{{CGscriptConstructors_Template|Description=Create a new BulletSetting for a Numeric list}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=array|Name=Color|HasGetter=1|HasSetter=1|Description=Get/Set Color of bullets and numbers}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsInList|HasGetter=1|HasSetter=1|Description=Get/Set if the paragraph is used in a list.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsPrefixed|HasGetter=1|HasSetter=1|Description=Get/Set if the number is prefixed with parent numbers.}}
{{CGscriptProperties_Template|ReturnType=int|Name=Level|HasGetter=1|HasSetter=1|Description=Get/Set Level of nesting of list element}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=int|Name=StartNumber|HasGetter=1|HasSetter=1|Description=Get/Set startnumber for this sequence - set to -1 for not set}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationBulletNumeric bulletNum = new TabulationBulletNumeric();
//For all bullet types
bulletNum.Level = 1;//Defines what level of the list we want the paragraph.
bulletNum.Color = Color_getByName("green");
bulletNum.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));</source>

TabulationBullet class

2016-06-24T10:05:20Z

MortenHattingVoltelen:

Abstract base class

See

[[TabulationBulletDot class|TabulationBulletDot_class]]

[[TabulationBulletNumeric class|TabulationBulletNumeric_class]]

[[Category:Classes]]

Tabulation setHasPageNumber

2016-06-24T09:56:40Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_setHasPageNumber ====

OBSOLETE SINCE V. 6.0

Set page number to PDF file

'''Syntax'''

Tabulation_setHasPageNumber(boolValue)

'''Arguments'''

boolValue: is bool. If boolValue = true, page number is set, whereas page number is not set.

'''Return value'''

empty

'''Example'''

''<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki>''

''number a = createFrequenceDiagram("Single");''

''number reportUniqueId = Tabulation_saveAsReport("bug bug", 15707010, groups, true);''

''Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);''

''Tabulation_setFooterText("Loser");''

''Tabulation_setHasPageNumber(true);''

''Tabulation_setShowResultAsPdf(true);''

''//Result: PDF file will be shown page number.''

'''Availability'''

Version 5.7

OBSOLETE SINCE V. 6.0

__NOTOC__

Tabulation setHasPageNumber

2016-06-24T09:35:53Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_setHasPageNumber ====

OBSOLETE SINCE V. 6.0

Set page number to PDF file

'''Syntax'''

Tabulation_setHasPageNumber(boolValue)

'''Arguments'''

boolValue: is bool. If boolValue = true, page number is set, whereas page number is not set.

'''Return value'''

empty

'''Example'''

''<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki>''

''number a = createFrequenceDiagram("Single");''

''number reportUniqueId = Tabulation_saveAsReport("bug bug", 15707010, groups, true);''

''Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);''

''Tabulation_setFooterText("Loser");''

''Tabulation_setHasPageNumber(true);''

''Tabulation_setShowResultAsPdf(true);''

''//Result: PDF file will be shown page number.''

'''Availability'''

Version 5.7 __NOTOC__

Tabulation getStartingPageNumber

2016-06-24T09:29:19Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_getStartingPageNumber|ReturnType=Number
}}

{{HelpFiles}}

==== Tabulation_getStartingPageNumber ====

Sets the starting page number for the pdf report

'''Syntax'''

Tabulation_setStartingPageNumber()

'''Arguments'''

none

'''Return value'''

''number'' start page number

{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

 Version 6.0

Tabulation getStartingPageNumber

2016-06-24T09:27:23Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_getStartingPageNumber|ReturnType=Number
}}

{{HelpFiles}}

==== Tabulation_getStartingPageNumber ====

Sets the starting page number for the pdf report

'''Syntax'''

Tabulation_setStartingPageNumber()

'''Arguments'''

none

'''Return value'''

''number''

{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

 Version 6.0

Tabulation getStartingPageNumber

2016-06-24T09:25:33Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_getStartingPageNumber|ReturnType=Number
}}

{{HelpFiles}}

==== Tabulation_getStartingPageNumber ====

Sets the starting page number for the pdf report '''Syntax'''

Tabulation_setStartingPageNumber()

'''Arguments'''

none

'''Return value'''

''number''

 

{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

 Version 6.0

Tabulation getStartingPageNumber

2016-06-24T09:25:20Z

MortenHattingVoltelen: Created page with "{{Function_Template|Name=Tabulation_getStartingPageNumber|ReturnType=Number }} {{HelpFiles}} ==== Tabulation_getStartingPageNumber ==== Sets the starting page number for th..."

{{Function_Template|Name=Tabulation_getStartingPageNumber|ReturnType=Number
}}

{{HelpFiles}}

==== Tabulation_getStartingPageNumber ====

Sets the starting page number for the pdf report
'''Syntax'''

Tabulation_setStartingPageNumber()

'''Arguments'''

none

'''Return value'''

''number''
[[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

Tabulation getPdfMargin

2016-06-24T09:14:41Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_getPdfMargin|ReturnType=Number
|Parameters=
|Name=SetMarginType|ConstantType=Number|EnumType=PDFMARGIN
}}

{{HelpFiles}}

==== Tabulation_getPdfMargin ====

Gets a given margin in the Pdf report

'''Syntax'''

Tabulation_getPdfMargin(''marginType'')

'''Arguments'''

*''marginType'': A enumeration for the margin to be set. Choose between the following:

Diagram_PdfHeader_Margin_Top

Diagram_PdfHeader_Margin_Bottom

Diagram_PdfFooter_Margin_Top

Diagram_PdfFooter_Margin_Bottom

'''Return value'''

''number'' marginValue

 {{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

Version 6.0

Tabulation getPdfMargin

2016-06-24T09:14:15Z

MortenHattingVoltelen: Created page with "{{Function_Template|Name=Tabulation_getPdfMargin|ReturnType=Number |Parameters= |Name=<nowiki>SetMarginType</nowiki>|ConstantType=Number|EnumType=PDFMARGIN }} {{HelpFiles}} ..."

{{Function_Template|Name=Tabulation_getPdfMargin|ReturnType=Number
|Parameters=
|Name=<nowiki>SetMarginType</nowiki>|ConstantType=Number|EnumType=PDFMARGIN
}}
{{HelpFiles}}

==== Tabulation_getPdfMargin====

Gets a given margin in the Pdf report

'''Syntax'''

Tabulation_getPdfMargin(''marginType'')

'''Arguments'''

*''marginType'': A enumeration for the margin to be set. Choose between the following:

Diagram_PdfHeader_Margin_Top

Diagram_PdfHeader_Margin_Bottom

Diagram_PdfFooter_Margin_Top

Diagram_PdfFooter_Margin_Bottom

'''Return value'''

''bool''

 {{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''
[[category:Diagram/report generating CGScript functions]]

'''Availability'''

Version 6.0

Tabulation setPdfMargin

2016-06-24T09:07:48Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_setPdfMargin|ReturnType=Empty
|Parameters=
|Name=SetMarginType|ConstantType=Number|EnumType=PDFMARGIN,
|Name=SetMarginPoints|ConstantType=Number|IsInteger=1
}}
{{HelpFiles}}

==== Tabulation_setPdfMargin ====

Sets a given margin in the Pdf report

'''Syntax'''

Tabulation_setPdfMargin(''marginType'',''margin'')

'''Arguments'''

*''marginType'': A enumeration for the margin to be set. Choose between the following:

Diagram_PdfHeader_Margin_Top

Diagram_PdfHeader_Margin_Bottom

Diagram_PdfFooter_Margin_Top

Diagram_PdfFooter_Margin_Bottom

*''margin'': The value the margin should have. Valid value: 0-100

=== '''Examples''' ===

<source lang="javascript">
//Set the margins on the header or footer:
//Tabulation_SetPDFMargin(marginType, margin)
// Diagram_PdfHeader_Margin_Top / Diagram_PdfHeader_Margin_Bottom
// Diagram_PdfFooter_Margin_Top / Diagram_PdfFooter_Margin_Bottom
//Needs a DCS
Tabulation_setPdfMargin(Diagram_PdfHeader_Margin_Top , 100);
Tabulation_setPdfMargin(Diagram_PdfFooter_Margin_Bottom, 100);
</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

Tabulation setStartingPageNumber

2016-06-24T08:51:16Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_addFooterImage ====

Adds an image to the footer

'''Syntax'''

Tabulation_setStartingPageNumber(''8'')

'''Arguments'''
int pagenumber

=== '''Examples''' ===

<source lang="javascript">

//Starting page number of the PDF report can be set:
//Needs a DCS

Tabulation_setStartingPageNumber(8);
</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

Tabulation addFooterImage

2016-06-24T08:48:03Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_addFooterImage ====

Adds an image to the footer

'''Syntax'''

Tabulation_addFooterImage(''TabulationImage'')

'''Arguments'''

*[[TabulationImage class|''TabulationImage'']]

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_IDENTICAL,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, HeFoPaRight);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addFooterImage(t2);

</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

Tabulation addFooterParagraph

2016-06-24T08:47:38Z

MortenHattingVoltelen:

==== Tabulation_addFooterParagraph ====

Adds an paragraph to the footer

'''Syntax'''

Tabulation_addFooterParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

<source lang="javascript">
//Footer
TabulationParagraphStyle paragraphStyleFooter1 = new TabulationParagraphStyle();

//Inline
Tabulation_addFooterParagraph(new TabulationParagraph(paragraphStyleFooter1, "Voxmeter for customer", textStyleHeaderFooter));

paragraphStyleFooter1.Alignment = "right";
Tabulation_addFooterParagraph(new TabulationParagraph(paragraphStyleFooter1, "Page $p of $P", textStyleHeaderFooter));
//Constants that are changed: $p to current page number and $P to total number of pages.
</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

Tabulation addHeaderImage

2016-06-24T08:47:21Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_addHeaderImage ====

Adds an image to the header

'''Syntax'''

Tabulation_addHeaderImage(''TabulationImage'')

'''Arguments'''

*[[TabulationImage class|''TabulationImage'']]

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_IDENTICAL,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, HeFoPaRight);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addHeaderImage(t2);

</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

Tabulation addHeaderParagraph

2016-06-24T08:46:57Z

MortenHattingVoltelen:

==== Tabulation_addHeaderParagraph ====

Adds an paragraph to the header

'''Syntax'''

Tabulation_addHeaderParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

<source lang="javascript">
//Header
//We need a TabulationParagraphStyle, like with a normal paragraph.
TabulationParagraphStyle paragraphStyleHeader1 = new TabulationParagraphStyle();
paragraphStyle.Alignment = "left"; //The alignment decides what column the paragraph is shown in - left/center/right

//It also needs a normal TabulationTextStyle.
TabulationTextStyle textStyleHeaderFooter = new TabulationTextStyle();

Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Test", textStyleHeaderFooter));
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Test Line 2", textStyleHeaderFooter));
paragraphStyleHeader1.Alignment = "center";
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Vox Titel", textStyleHeaderFooter));
paragraphStyleHeader1.Alignment = "right";
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "dd/mm/yyyy", textStyleHeaderFooter));
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Report X", textStyleHeaderFooter));</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

Tabulation addImage

2016-06-24T08:46:36Z

MortenHattingVoltelen:

{{HelpFiles}}

==== Tabulation_addImage ====

Adds an image to the report

'''Syntax'''

Tabulation_addImage(''TabulationImage'')

'''Arguments'''

*[[TabulationImage class|''TabulationImage'']]

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_IDENTICAL,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, tps);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addImage(t2);

</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

Tabulation addParagraph

2016-06-24T08:44:13Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty
|Parameters=
|Name=Paragraph|ConstantType=Object
}}

==== Tabulation_addParagraph ====

Adds an paragraph to the report

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

<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>
[[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

Tabulation setHeaderText

2016-06-24T08:02:34Z

MortenHattingVoltelen:

{{HelpFiles}}

===== Tabulation_setHeaderText =====
OBSOLETE SINCE V. 6.0

Set page number to PDF file

'''Syntax'''

Tabulation_setHeaderText(text)

'''Arguments'''

text: is string which is header text of PDF file

'''Return value'''

empty

'''Example'''

''<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki>''

''number a = createFrequenceDiagram("Single");''

''number reportUniqueId = Tabulation_saveAsReport("test test", 15707010, groups, true);''

''Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);''

''Tabulation_setHeaderText("Hero");''

''Tabulation_setShowResultAsPdf(true);''

''//Result: Header text of PDF file is "Hero"''

{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

Version 5.7 __NOTOC__
OBSOLETE SINCE V. 6.0

Tabulation setFooterText

2016-06-24T07:59:52Z

MortenHattingVoltelen:

{{HelpFiles}}

===== Tabulation_setFooterText =====

OBSOLETE SINCE V. 6.0

Set footer text to PDF file

'''Syntax'''

Tabulation_setFooterText(text);

'''Arguments'''

text: is string. It is the footer user wants to set.

'''Return value'''

empty

'''Example'''

''<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki>''

''number a = createFrequenceDiagram("Single");''

''number reportUniqueId = Tabulation_saveAsReport("test test", 15707010, groups, true);''

''Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);''

''Tabulation_setFooterText("Winner");''

''Tabulation_setShowResultAsPdf(true);''

''//Result: Footer text of PDF file is "Winner"''

{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].''

'''Availability'''

Version 5.7 __NOTOC__
OBSOLETE SINCE V. 6.0

Tabulation setFooterText

2016-06-24T07:59:31Z

MortenHattingVoltelen:

Tabulation addText

2016-06-24T07:53:03Z

MortenHattingVoltelen:

= Tabulation_addText =

OBSOLETE SINCE V. 6.0

Add text into the Tabulation result. Please take a look at the below example for more detail.

== Syntax ==

Tabulation_addText(text)

== Parameters ==

*text: is the text you want to add to the your tabulation result. It is a string type

== Examples ==

<source lang="javascript">
DCS_use(37244952);
Tabulation_addText("Table: Age");
createFrequenceDiagram("S_Age");
</source>

__NOTOC__

TabulationParagraphStyle class

2016-06-23T12:53:28Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=<nowiki>TabulationParagraphStyle</nowiki>
|Description=<nowiki>Styles for a paragraph</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new ParagraphStyle</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetBulletSetting</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=TabulationBullet|Name=<nowiki>bulletSettings</nowiki>|Description=<nowiki>Styling of the bullets</nowiki>}}
|Description=<nowiki>Apply Bulletsettings to paragraphStyle to turn the paragraph into a list of bullets</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Alignment</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set alignment of paragraph: Left, Right, Center, Justify</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsHtml</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set IsHtml. Defines if the paragraph contains html that should be parsed.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginBottomPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginBottom in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginLeftPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginLeft in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginRightPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginRight in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginTopPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginTop in points. Must be 0-400 points</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>}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
paragraphStyle.Alignment = "center"; //left, right, center.
paragraphStyle.MarginTopPoints = 10; //0-400
paragraphStyle.MarginLeftPoints = 10;//0-400
</source>

TabulationTextStyle class

2016-06-23T11:11:15Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=<nowiki>TabulationTextStyle</nowiki>
|Description=<nowiki>Styles for use on a portion of text</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new TabulationTextStyle</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Bold</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Bold to string.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Color of string.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FontFace</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set FontFace of string.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>FontSize</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set FontSize of string in points. Must be 1-400 points</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=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|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>}}
}}

=== '''Examples''' ===

<source lang="javascript">
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;
</source>

TabulationParagraphStyle class

2016-06-23T11:10:27Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=TabulationParagraphStyle
|Description=Styles for a paragraph
|Constructors=
{{CGscriptConstructors_Template|Description=Create a new ParagraphStyle}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetBulletSetting|Parameters=
{{CGscriptParameters_Template|Type=TabulationBullet|Name=bulletSettings|Description=Styling of the bullets}}
|Description=Apply Bulletsettings to paragraphStyle to turn the paragraph into a list of bullets}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=Alignment|HasGetter=1|HasSetter=1|Description=Get/Set alignment of paragraph: Left, Right, Center, Justify}}
{{CGscriptProperties_Template|ReturnType=int|Name=MarginBottomPoints|HasGetter=1|HasSetter=1|Description=Get/Set marginBottom in points. Must be 0-400 points}}
{{CGscriptProperties_Template|ReturnType=int|Name=MarginLeftPoints|HasGetter=1|HasSetter=1|Description=Get/Set marginLeft in points. Must be 0-400 points}}
{{CGscriptProperties_Template|ReturnType=int|Name=MarginRightPoints|HasGetter=1|HasSetter=1|Description=Get/Set marginRight in points. Must be 0-400 points}}
{{CGscriptProperties_Template|ReturnType=int|Name=MarginTopPoints|HasGetter=1|HasSetter=1|Description=Get/Set marginTop in points. Must be 0-400 points}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
paragraphStyle.Alignment = "center"; //left, right, center.
paragraphStyle.MarginTopPoints = 10; //0-400
paragraphStyle.MarginLeftPoints = 10;//0-400
</source>

TabulationParagraphStyle class

2016-06-23T11:09:40Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=<nowiki>TabulationParagraphStyle</nowiki>
|Description=<nowiki>Styles for a paragraph</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create a new ParagraphStyle</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetBulletSetting</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=TabulationBullet|Name=<nowiki>bulletSettings</nowiki>|Description=<nowiki>Styling of the bullets</nowiki>}}
|Description=<nowiki>Apply Bulletsettings to paragraphStyle to turn the paragraph into a list of bullets</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Alignment</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set alignment of paragraph: Left, Right, Center, Justify</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginBottomPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginBottom in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginLeftPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginLeft in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginRightPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginRight in points. Must be 0-400 points</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MarginTopPoints</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set marginTop in points. Must be 0-400 points</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>}}
}}

=== '''Examples''' ===

<source lang="javascript">
TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
paragraphStyle.Alignment = "center"; //left, right, center.
paragraphStyle.MarginTopPoints = 10; //1-399
paragraphStyle.MarginLeftPoints = 10;//1-399
</source>

TabulationParagraph class

2016-06-23T11:01:47Z

MortenHattingVoltelen:

{{CGscriptClass_Template
|Name=TabulationParagraph
|Description=A paragraph possible to add to reports. Contains portions and paragraph specific styling
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=TabulationParagraphStyle|Name=paragraphStyle|Description=Styling of the paragraph}}
|Description=Create a new empty Paragraph}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=TabulationParagraphStyle|Name=paragraphStyle|Description=Styling of the paragraph|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=text|Description=Text to be added as first portion|Comma=,}}{{CGscriptParameters_Template|Type=TabulationTextStyle|Name=textStyle|Description=The style to applied to the portion}}
|Description=Create a new Paragraph with a portion}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddLink|Parameters=
{{CGscriptParameters_Template|Type=string|Name=text|Description=Text to be added to the paragraph|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=link|Description=Link on the text|Comma=,}}{{CGscriptParameters_Template|Type=TabulationTextStyle|Name=textStyle|Description=The style to applied to the portion}}
|Description=Add a new portion with link to the Paragraph}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddPortion|Parameters=
{{CGscriptParameters_Template|Type=string|Name=text|Description=Text to be added to the paragraph|Comma=,}}{{CGscriptParameters_Template|Type=TabulationTextStyle|Name=textStyle|Description=The style to applied to the portion}}
|Description=Add a new portion to the Paragraph}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== '''Examples''' ===

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

//Add a new simple paragraph to the report in one line:
Tabulation_addParagraph(new TabulationParagraph(tps,"SubHeading",textStyle));
</source>

TabulationParagraph class

2016-06-23T11:01:05Z

MortenHattingVoltelen:

Tabulation addParagraph

2016-06-23T07:23:05Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty
|Parameters=
|Name=Paragraph|ConstantType=Object
}}

==== Tabulation_addParagraph ====

Adds an paragraph to the report

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

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

[[Category:Diagram/report_generating_CGScript_functions]]

Tabulation addParagraph

2016-06-23T07:19:40Z

MortenHattingVoltelen:

[[Category:report_generating_CGScript_functions]]

{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty
|Parameters=
|Name=Paragraph|ConstantType=Object
}}

==== Tabulation_addParagraph ====

Adds an paragraph to the report

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

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

Tabulation addParagraph

2016-06-23T07:09:46Z

MortenHattingVoltelen:

[[Category:Functions]]
{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty
|Parameters=
|Name=Paragraph|ConstantType=Object
}}

==== Tabulation_addParagraph ====

Adds an paragraph to the report

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

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

Tabulation addFooterImage

2016-06-22T11:55:43Z

MortenHattingVoltelen: Created page with "{{HelpFiles}} ==== Tabulation_addFooterImage ==== Adds an image to the footer '''Syntax''' Tabulation_addFooterImage(''TabulationImage'') '''Arguments''' *TabulationIm..."

Tabulation addImage

2016-06-22T11:54:42Z

MortenHattingVoltelen:

Tabulation addHeaderImage

2016-06-22T11:52:53Z

MortenHattingVoltelen:

Tabulation addHeaderImage

2016-06-22T11:48:11Z

MortenHattingVoltelen: Created page with "{{HelpFiles}} ==== Tabulation_addHeaderImage ==== Adds an image to the header '''Syntax''' Tabulation_addHeaderImage(''TabulationImage'') '''Arguments''' *TabulationIm..."

{{HelpFiles}}

==== Tabulation_addHeaderImage ====

Adds an image to the header

'''Syntax'''

Tabulation_addHeaderImage(''TabulationImage'')

'''Arguments'''

*[[TabulationImage class|''TabulationImage'']]

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_ANYWHERE,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, HeFoPaRight);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addHeaderImage(t2);

</source>

Tabulation addFooterParagraph

2016-06-22T11:36:47Z

MortenHattingVoltelen:

Tabulation addHeaderParagraph

2016-06-22T11:36:09Z

MortenHattingVoltelen:

Tabulation addHeaderParagraph

2016-06-22T11:35:45Z

MortenHattingVoltelen:

==== Tabulation_addHeaderParagraph ====

Adds an paragraph to the header

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

<source lang="javascript">
//Header
//We need a TabulationParagraphStyle, like with a normal paragraph.
TabulationParagraphStyle paragraphStyleHeader1 = new TabulationParagraphStyle();
paragraphStyle.Alignment = "left"; //The alignment decides what column the paragraph is shown in - left/center/right

//It also needs a normal TabulationTextStyle.
TabulationTextStyle textStyleHeaderFooter = new TabulationTextStyle();

Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Test", textStyleHeaderFooter));
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Test Line 2", textStyleHeaderFooter));
paragraphStyleHeader1.Alignment = "center";
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Vox Titel", textStyleHeaderFooter));
paragraphStyleHeader1.Alignment = "right";
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "dd/mm/yyyy", textStyleHeaderFooter));
Tabulation_addHeaderParagraph(new TabulationParagraph(paragraphStyleHeader1, "Report X", textStyleHeaderFooter));</source>

Tabulation addParagraph

2016-06-22T11:34:55Z

MortenHattingVoltelen:

Tabulation addParagraph

2016-06-22T11:29:37Z

MortenHattingVoltelen:

{{Function_Template|Name=Tabulation_addParagraph|ReturnType=Empty
|Parameters=
|Name=Paragraph|ConstantType=Object
}}

==== Tabulation_addParagraph ====

Adds an image to the report

'''Syntax'''

Tabulation_addParagraph(''TabulationParagraph'')

'''Arguments'''

*[[TabulationParagraph class|''TabulationParagraph'']]

=== '''Examples''' ===

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

Tabulation addImage

2016-06-22T11:06:51Z

MortenHattingVoltelen:

Tabulation addImage

2016-06-22T10:44:58Z

MortenHattingVoltelen:

==== Tabulation_addImage ====

Adds an image to the report

'''Syntax'''

Tabulation_addImage(''TabulationImage'')

'''Arguments'''

*[[TabulationImage_class|''TabulationImage'']]

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_ANYWHERE,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, tps);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addImage(t2);

</source>

Tabulation addImage

2016-06-22T10:44:34Z

MortenHattingVoltelen:

==== Tabulation_addImage ====

Adds an image to the report

'''Syntax'''

Tabulation_addImage(''TabulationImage'')

'''Arguments'''

*''TabulationImage''

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_ANYWHERE,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, tps);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addImage(t2);

</source>

Tabulation addImage

2016-06-22T10:40:06Z

MortenHattingVoltelen:

=== '''Examples''' ===

<source lang="javascript">
Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_ANYWHERE,1,64);
Attachment img2 = new Attachment(image2[0][1]);

TabulationImage t2 = new TabulationImage(img2, tps);
//t.Opacity = 0.5;
t2.Height = 20;
Tabulation_addImage(t2);

</source>

Tabulation addImage

2016-06-22T10:39:42Z

MortenHattingVoltelen: Created page with "=== '''Examples''' === <source lang="javascript">Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH..."

=== '''Examples''' ===

<source lang="javascript">Array image2 = Resource_searchByName("voxmeterlogo",Resource_Type_Attachment,0,NAME_SEARCH_TYPE_ANYWHERE,1,64); Attachment img2 = new Attachment(image2[0][1]); TabulationImage t2 = new TabulationImage(img2, tps); //t.Opacity = 0.5; t2.Height = 20; Tabulation_addImage(t2); 
</source>

TabulationImage class

2016-06-22T10:01:34Z

MortenHattingVoltelen: Created page with "{{CGscriptClass_Template |Name=<nowiki>TabulationImage</nowiki> |Description=<nowiki>A image possible to add to reports. Contains an attachment and image relevant settings</no..."

{{CGscriptClass_Template
|Name=<nowiki>TabulationImage</nowiki>
|Description=<nowiki>A image possible to add to reports. Contains an attachment and image relevant settings</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=Attachment|Name=<nowiki>Attachment</nowiki>|Description=<nowiki>The id of the image as attachment</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationParagraphStyle|Name=<nowiki>paragraphStyle</nowiki>|Description=<nowiki>Styling of the paragraph</nowiki>}}
|Description=<nowiki>Create a new image</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Height</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set height in points for the picture - 1-400 set to -1 for not set</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Opacity</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set opacity for the picture - 0-1</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RotatingAngle</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set rotatingangle for the picture - -90 to 90</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Width</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set width in points for the picture - 1-400 set to -1 for not set</nowiki>}}
}}