Difference between revisions of "GVExcelWorkbookConfiguration"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== It is on this {{GVESB}} element where Report Excel formats will be configured. =={{VULCON}} / {{GVCONSOLE}} Configuration== The GVExcelWorkbookConfiguration El...")
 
Line 71: Line 71:
 
|-
 
|-
 
| NumberColumn || Defines the configuration of the columns of type number in a sheet. Contains the element Format
 
| NumberColumn || Defines the configuration of the columns of type number in a sheet. Contains the element Format
 +
|}
 +
 +
=====Format=====
 +
 +
Defines the configuration of the cell in a Report.
 +
 +
The following table shows the Format element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| minWidth || optional || Minimum width of the cell. Default 1.
 +
|-
 +
| maxWidth || optional || Maximum width of the cell. Default 30.
 +
|-
 +
| alignment || optional || Alignment of cell text. Default "LEFT".
 +
The attribute's admitted values are:
 +
* LEFT
 +
* CENTRE
 +
* RIGHT
 +
|-
 +
| hasBorder || optional || Border of the cell Default "0".
 +
The attribute's admitted values are:
 +
* true
 +
* false
 +
|-
 +
| scaleFactor || optional || Cell zoom. Default "1".
 +
|-
 +
| backgroundColour || optional || Background color of the cell. Default "white".
 +
|-
 +
| pattern || optional || Format of the cell Number and Date. Default: Number: @ Date : dd/MM/yyyy hh:mm:ss
 +
|}
 +
 +
Contains the subelements [[GVExcelWorkbookConfiguration#Font|Font]].
 +
 +
=====Font=====
 +
 +
Defines the configuration of a font in a report.
 +
 +
The following table shows the Font element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || optional || Type Default "ARIAL".
 +
The attribute's admitted values are:
 +
* ARIAL
 +
* COURIER
 +
* TAHOMA
 +
* TIMES
 +
|-
 +
| size || optional || Dimension. Default "10".
 +
|-
 +
| isBold || optional || Bold style. Default "false".
 +
|-
 +
| isItalic || optional || Italic Style. Default "false".
 +
|-
 +
| isUnderlined || optional || Underlined style. Default "false".
 
|}
 
|}

Revision as of 15:02, 14 February 2012

Description

It is on this GreenVulcano® ESB element where Report Excel formats will be configured.

VulCon / GV Console Configuration

The GVExcelWorkbookConfiguration Element is used by: GVAdapters and visible from the Adapter view of VulCon®.

The following table shows the GVExcelWorkbookConfiguration element's attributes:

Attribute Type Description
version fixed This attribute must assume the value 1.0.
type fixed This attribute must assume the value module.
name fixed This attribute must assume the value EXCEL_WORK.

Its subelements are:

GVExcelWorkbook

Defines the configuration elements of a Report.

The following table shows the GVExcelWorkbook element's attributes:

Attribute Type Description
configName required Format name.

There must be one with the value 'default'.

maxNumberOfSheets optional Max number of sheets in the report. Default 30.
sheetDefaultName optional Default name for sheets. Default Sheet.

Its subelements are:

SheetConfig

Defines the configuration of a sheet in a report.

The following table shows the SheetConfig element's attributes:

Attribute Type Description
offset optional Offset in rows to data start. Default 0.

The following table shows its subelements and their utilities:

Subelement Utility
Description
Title Defines the configuration of the title of a sheet. Has the attributes:
  • rowsFromTop: optional. Offset in rows. Default 0.
  • columnsFromLeft: optional. Offset in columns. Default 0.

Contains the element Format

TableHeader Defines the configuration header on a sheet. Contains the element Format
TextColumn Defines the configuration of the columns of type text in a sheet. Contains the element Format
DateColumn Defines the configuration of the columns of type date in a sheet. Contains the element Format
NumberColumn Defines the configuration of the columns of type number in a sheet. Contains the element Format
Format

Defines the configuration of the cell in a Report.

The following table shows the Format element's attributes:

Attribute Type Description
minWidth optional Minimum width of the cell. Default 1.
maxWidth optional Maximum width of the cell. Default 30.
alignment optional Alignment of cell text. Default "LEFT".

The attribute's admitted values are:

  • LEFT
  • CENTRE
  • RIGHT
hasBorder optional Border of the cell Default "0".

The attribute's admitted values are:

  • true
  • false
scaleFactor optional Cell zoom. Default "1".
backgroundColour optional Background color of the cell. Default "white".
pattern optional Format of the cell Number and Date. Default: Number: @ Date : dd/MM/yyyy hh:mm:ss

Contains the subelements Font.

Font

Defines the configuration of a font in a report.

The following table shows the Font element's attributes:

Attribute Type Description
type optional Type Default "ARIAL".

The attribute's admitted values are:

  • ARIAL
  • COURIER
  • TAHOMA
  • TIMES
size optional Dimension. Default "10".
isBold optional Bold style. Default "false".
isItalic optional Italic Style. Default "false".
isUnderlined optional Underlined style. Default "false".