Eclipse BIRT Report Object Model (ROM)

TOCStructure Structure

# Structure Overview

Represents a toc;each toc consists of an expression, style, and corresponding format style

### Details

Display Name: | toc
Since: | 2.2

### Property Summary

TOCStyle
  style for toc
backgroundColor
borderBottomColor
borderBottomStyle
borderBottomWidth
borderLeftColor
borderLeftStyle
borderLeftWidth
borderRightColor
borderRightStyle
borderRightWidth
borderTopColor
borderTopStyle
borderTopWidth
color
dateTimeFormat
expressionValue
  An expression that returns a string that is to appear in the Table of Contents for this item or its container
fontFamily
fontSize
fontStyle
fontVariant
fontWeight
numberAlign
numberFormat
stringFormat
textAlign
textIndent
textLineThrough
textOverline
textTransform
textUnderline

### Description

A table of contents entry for this item

# Property Detail

## TOCStyle Property

style for toc

### Details

Type: | Style Reference
Since: | 2.2
Required: | No
Display Name: | style of TOC
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### See Also

## backgroundColor Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | background color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## borderBottomColor Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | border bottom color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## borderBottomStyle Property

### Details

Type: | choice (lineStyle)
Since: | 1.0
Required: | No
Display Name: | border bottom style
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line style | none |
solid | Solid | solid |
dotted | Dotted | dotted |
dashed | Dashed | dashed |
double | Double | double |
groove | Groove | groove |
ridge | Ridge | ridge |
inset | Inset | inset |
outset | Outset | outset |

## borderBottomWidth Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | border bottom width
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
thin | Thin | thin |
medium | Medium | medium |
thick | Thick | thick |

## borderLeftColor Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | bordre Left color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## borderLeftStyle Property

### Details

Type: | choice (lineStyle)
Since: | 1.0
Required: | No
Display Name: | border Left style
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line style | none |
solid | Solid | solid |
dotted | Dotted | dotted |
dashed | Dashed | dashed |
double | Double | double |
groove | Groove | groove |
ridge | Ridge | ridge |
inset | Inset | inset |
outset | Outset | outset |

## borderLeftWidth Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | border Left width
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
thin | Thin | thin |
medium | Medium | medium |
thick | Thick | thick |

## borderRightColor Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | border right color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## borderRightStyle Property

### Details

Type: | choice (lineStyle)
Since: | 1.0
Required: | No
Display Name: | border right style
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line style | none |
solid | Solid | solid |
dotted | Dotted | dotted |
dashed | Dashed | dashed |
double | Double | double |
groove | Groove | groove |
ridge | Ridge | ridge |
inset | Inset | inset |
outset | Outset | outset |

## borderRightWidth Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | border right width
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
thin | Thin | thin |
medium | Medium | medium |
thick | Thick | thick |

## borderTopColor Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | border Top color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## borderTopStyle Property

### Details

Type: | choice (lineStyle)
Since: | 1.0
Required: | No
Display Name: | border Top style
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line style | none |
solid | Solid | solid |
dotted | Dotted | dotted |
dashed | Dashed | dashed |
double | Double | double |
groove | Groove | groove |
ridge | Ridge | ridge |
inset | Inset | inset |
outset | Outset | outset |

## borderTopWidth Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | border Top width
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
thin | Thin | thin |
medium | Medium | medium |
thick | Thick | thick |

## color Property

### Details

Type: | color
Since: | 1.0
Required: | No
Display Name: | font color
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
maroon | Maroon | maroon |
red | Red | red |
orange | Orange | orange |
yellow | Yellow | yellow |
olive | Olive | olive |
purple | Purple | purple |
fuchsia | Fuchsia | fuchsia |
white | White | white |
lime | Lime | lime |
green | Green | green |
navy | Navy | navy |
blue | Blue | blue |
aqua | Aqua | aqua |
teal | Teal | teal |
black | Black | black |
silver | Silver | silver |
gray | Gray | gray |

## dateTimeFormat Property

### Details

Type: | DateTimeFormatValue Structure
Since: | 1.0
Required: | No
Display Name: | format dateTime
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

## expressionValue Property

An expression that returns a string that is to appear in the Table of Contents for this item or its container

### Details

Type: | expression
Context: |
Expression Type: | any
Since: | 2.2
Required: | No
Display Name: | expression
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### See Also

## fontFamily Property

### Details

Type: | string
Since: | 1.0
Required: | No
Display Name: | font family
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
serif | Serif | serif |
sans-serif | Sans Serif | sans-serif |
cursive | Cursive | cursive |
fantasy | Fantasy | fantasy |
monospace | Monospace | monospace |

## fontSize Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | font size
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
xx-small | XX Small | xx-small |
x-small | X Small | x-small |
small | Small | small |
medium | Medium | medium |
large | Large | large |
x-large | X Large | x-large |
xx-large | XX Large | xx-large |
larger | Larger | larger |
smaller | Smaller | smaller |

## fontStyle Property

### Details

Type: | choice (fontStyle)
Since: | 1.0
Required: | No
Display Name: | font style
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
normal | Normal | normal |
italic | Italic | italic |
oblique | Oblique | oblique |

## fontVariant Property

### Details

Type: | choice (fontVariant)
Since: | 1.0
Required: | No
Display Name: | font variant
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
normal | Normal | normal |
small-caps | Small Caps | small-caps |

## fontWeight Property

### Details

Type: | choice (fontWeight)
Since: | 1.0
Required: | No
Display Name: | font weight
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
normal | Normal | normal |
bold | Bold | bold |
bolder | Bolder | bolder |
lighter | Lighter | lighter |
100 | 100 | 100 |
200 | 200 | 200 |
300 | 300 | 300 |
400 | 400 | 400 |
500 | 500 | 500 |
600 | 600 | 600 |
700 | 700 | 700 |
800 | 800 | 800 |
900 | 900 | 900 |

## numberAlign Property

### Details

Type: | choice (textAlign)
Since: | 1.0
Required: | No
Display Name: | format number align
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
left | Left | left |
center | Center | center |
right | Right | right |
justify | Justify | justify |

## numberFormat Property

### Details

Type: | NumberFormatValue Structure
Since: | 1.0
Required: | No
Display Name: | format number
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

## stringFormat Property

### Details

Type: | StringFormatValue Structure
Since: | 1.0
Required: | No
Display Name: | format string
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

## textAlign Property

### Details

Type: | choice (textAlign)
Since: | 1.0
Required: | No
Display Name: | text align
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
left | Left | left |
center | Center | center |
right | Right | right |
justify | Justify | justify |

## textIndent Property

### Details

Type: | dimension
Since: | 1.0
Required: | No
Display Name: | text indent
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

## textLineThrough Property

### Details

Type: | choice (textLineThrough)
Since: | 1.0
Required: | No
Display Name: | font text linethrough
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line through text | none |
line-through | Line-through | line-through |

## textOverline Property

### Details

Type: | choice (textOverline)
Since: | 1.0
Required: | No
Display Name: | font text overline
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No line over text | none |
overline | Overline | overline |

## textTransform Property

### Details

Type: | choice (transform)
Since: | 1.0
Required: | No
Display Name: | text transform
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
capitalize | Capitalize | capitalize |
uppercase | Upper Case | uppercase |
lowercase | Lower Case | lowercase |
none | No transformation | none |

## textUnderline Property

### Details

Type: | choice (textUnderline)
Since: | 1.0
Required: | No
Display Name: | font text underline
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
none | No underline | none |
underline | Underline | underline |