Main Content

mlreportgen.dom.ColSep Class

Namespace: mlreportgen.dom

Draw lines between table columns

Description

Draw lines between table columns.

The mlreportgen.dom.ColSep class is a handle class.

Creation

Description

colSepObj = ColSep creates unspecified column separators.

colSepObj = ColSep(style) creates a column separator of the specified style.

colSepObj = ColSep(style,color) creates a column separator having the specified style and color.

example

colSepObj = ColSep(style,color,width) creates a column separator having the specified style, color, and width.

Input Arguments

expand all

Style of the table column separator, specified as one of these values.

ValueSupported in DOCXSupported in HTML and PDF
'dashed'YesYes
'dashdotstroked'YesNo
'dashsmallgap'YesNo
'dotted'YesYes
'dotdash'YesNo
'dotdotdash'YesNo
'double'YesYes
'doublewave'YesNo
'inset'YesYes
'none'YesYes
'outset'YesYes
'single'YesNo
'solid'NoYes
'thick'YesNo
'thickthinlargegap'YesNo
'thickthinmediumgap'YesNo
'thickthinsmallgap'YesNo
'thinthicklargegap'YesNo
'thinthickmediumgap'YesNo
'thinthicksmallgap'YesNo
'thinthickthinlargegap'YesNo
'thinthickthinmediumgap'YesNo
'thinthickthinsmallgap'YesNo
'threedemboss'YesNo
'threedengrave'YesNo
'triple'YesNo
'wave'YesNo

You can specify:

Separator width as a percentage, for example, '100%', or a number of units of measurement in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Properties

expand all

You can specify:

Separator width as a percentage, for example, '100%', or a number of units of measurement in the form valueUnits. Units is an abbreviation for the units. Use one of these abbreviations for the units of a width.

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Data Types: char

Format specification for this document element object, specified as an array of format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

Tag for mlreportgen.dom.ColSep object, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for mlreportgen.dom.ColSep object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Examples

collapse all

This example creates table and sets the border, column separator, and row separator styles. The TableEntriesStyle property formats the table entries.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
t = Table(magic(5));

t.Style = { ...
    RowHeight('0.75in'), ...
    Border('solid','Green','6pt'), ...
    ColSep('double','DarkGreen','3pt'), ...
    RowSep('single','DarkGreen')};

t.TableEntriesStyle = { ...
    Width('0.75in'), ...
    InnerMargin('0'), ...
    OuterMargin('0'), ...
    HAlign('center'), ...
    VAlign('middle') };
    
append(d,t);
close(d);
rptview(d.OutputPath);

Version History

Introduced in R2014b