Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFTableMBS class.

Next items

DynaPDFTableMBS.AddColumn(left as boolean, width as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a column to the table.

See also AddColumn function in DynaPDF manual.

DynaPDFTableMBS.AddRows(count as UInt32, height as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a couple of rows with given height.

See also AddRows function in DynaPDF manual.

DynaPDFTableMBS.ClearColumn(Col as Integer, Types as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function deletes the content in the specified column in all rows.

The paramter Types is described in ClearContent() below.

See also ClearColumn function in DynaPDF manual.

DynaPDFTableMBS.ClearContent(Types as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Clears content of table.

See kdc constants for possible flags.

See also ClearContent function in DynaPDF manual.

DynaPDFTableMBS.ClearRow(Row as Integer, Types as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function deletes the content in the specified row.

The paramter Types is described in ClearContent().

See also ClearRow function in DynaPDF manual.

DynaPDFTableMBS.Constructor   Private

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The private constructor.

DynaPDFTableMBS.DeleteColumn(column as UInt32)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Deletes the column.

DynaPDFTableMBS.DeleteRow(row as UInt32)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Deletes the row with the given index.

See also DeleteRow function in DynaPDF manual.

DynaPDFTableMBS.DeleteRows

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Deletes all rows.

See also DeleteRows function in DynaPDF manual.

DynaPDFTableMBS.DrawTable(x as Double, y as Double, MaxHeight as Double = 0.0) as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Draws the table at the given position into the PDF:

The function draws the table on the specified position. The x/y-coordinates specify the top left cornerof the table. The table flows always from top to bottom.

The function must be executed in a while statement if the parameter MaxHeight is set to a value greater than zero.

The function draws the header rows if any and at least one row to avoid an endless loop if themaximum height would be smaller as the first row height.

If the function succeeds the return value is the height of the table that was drawn so that additionalcontents can be drawn below the table if necessary. If the function fails the return value is -1.

Some examples using this method:

See also DrawTable function in DynaPDF manual.

DynaPDFTableMBS.GetFirstRow as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries first row from last draw operation.

Some examples using this method:

See also GetFirstRow function in DynaPDF manual.

DynaPDFTableMBS.GetFlags(Row as Integer, Column as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries flag for a cell, a column or a row.

If Row is -1, only column flags are returned. If Column is -1, the row flags are returned for given row.

See also GetFlags function in DynaPDF manual.

DynaPDFTableMBS.GetNextHeight(MaxHeight as Double, byref NextRow as Integer) as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the next row.
Example
dim pdf as new DynaPDFMBS
call pdf.CreateNewPDF(nil)
call pdf.Append

// create dummy table with 20 rows, 1 column and 500 points width. 20 points per row by default.
dim table as DynaPDFTableMBS = pdf.CreateTable(20, 1, 500.0, 20.0)

// fill in dummy data
for i as Integer = 1 to 20
dim rowNum as Integer = table.AddRow
call table.SetCellText(rowNum, 0, pdf.ktaLeft, table.kcoCenter, str(i))
next

// and do some calculations
dim nextrow as Integer
dim h as Double = table.GetNextHeight(0, nextrow)

MsgBox str(h)+" with no limit."

dim h2 as Double = table.GetNextHeight(200, nextrow)

MsgBox str(h2)+" with limit of 200 and rows till "+str(nextrow-1)

break

If MaxHeight is zero, returns the height of table.
If MaxHeight is the height of space available, plugin calculates the effective height of table and which row would be the next one.
Returns negative number on error.

See also GetNextHeight function in DynaPDF manual.

DynaPDFTableMBS.GetNextRow as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries next row of last draw operation.

Some examples using this method:

See also GetNextRow function in DynaPDF manual.

DynaPDFTableMBS.GetNumCols as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries number of columns of last draw operation.

See also GetNumCols function in DynaPDF manual.

DynaPDFTableMBS.GetNumRows as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries number of rows of last draw operation.

See also GetNumRows function in DynaPDF manual.

DynaPDFTableMBS.GetTableHeight as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the table height.

See also GetTableHeight function in DynaPDF manual.

DynaPDFTableMBS.GetTableWidth as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Calculates table width.

See also GetTableWidth function in DynaPDF manual.

DynaPDFTableMBS.HaveMore as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether there are more rows to draw.

If you draw a table, you can loop and fill pages until the whole table is drawn.

Some examples using this method:

See also HaveMore function in DynaPDF manual.

DynaPDFTableMBS.SetBackColor(Row as Integer, Column as Integer, channels() as Integer, ExtColorSpace as Integer = 0, ColorSpaceHandle as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the back color of the table, a row or cells.
Example
dim pdf as DynaPDFMBS // your PDF environment
dim tbl as DynaPDFTableMBS = pdf.CreateTable(3, 3, 500.0, 20.0) // make some table

const allRows = -1
const allColumns = -1

// add a few rows
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)

// row 0 in 100% Cyan
call tbl.SetBackColor(0, allColumns, array(255,0,0,0), pdf.kcsDeviceCMYK)
// row 1 in 100% Cyan
call tbl.SetBackColor(1, allColumns, array(0, 255, 0, 0), pdf.kcsDeviceCMYK)
// row 2 in 100% Cyan
call tbl.SetBackColor(2, allColumns, array(0, 0, 255, 0), pdf.kcsDeviceCMYK)
// row 3 in RGB red with 50% transparency
call tbl.SetBackColor(3, allColumns, array(255, 0, 0))

Default is none (transparent)
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass an integer for each channel with 0 to 255.

See also:

Some examples using this method:

DynaPDFTableMBS.SetBackColor(Row as Integer, Column as Integer, paramarray channels as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the back color of the table, a row or cells.
Example
dim pdf as DynaPDFMBS // your PDF environment
dim tbl as DynaPDFTableMBS = pdf.CreateTable(3, 3, 500.0, 20.0) // make some table

// now fill all rows and columns with RGB red specified by integer values
const allRows = -1
const allColumns = -1
call tbl.SetBackColor(allRows, allColumns, 255, 0, 0)

Default is none (transparent)
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass an integer for each channel with 0 to 255.

See also:

DynaPDFTableMBS.SetBackColorFloat(Row as Integer, Column as Integer, channels() as Double, ExtColorSpace as Integer = 0, ColorSpaceHandle as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the back color of the table, a row or cells.
Example
dim pdf as DynaPDFMBS // your PDF environment
dim tbl as DynaPDFTableMBS = pdf.CreateTable(3, 3, 500.0, 100.0) // make some table

const allRows = -1
const allColumns = -1

// add a few rows
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)
rowNum = tbl.AddRow(-1.0)

// row 0 in 100% Cyan
call tbl.SetBackColorFloat(0, allColumns, array(1.0, 0.0, 0.0, 0.0), pdf.kcsDeviceCMYK)
// row 1 in 100% Cyan
call tbl.SetBackColorFloat(1, allColumns, array(0.0, 1.0, 0.0, 0.0), pdf.kcsDeviceCMYK)
// row 2 in 100% Cyan
call tbl.SetBackColorFloat(2, allColumns, array(0.0, 0.0, 1.0, 0.0), pdf.kcsDeviceCMYK)
// row 3 in RGB red
call tbl.SetBackColorFloat(3, allColumns, array(1.0, 0.0, 0.0))

Default is none (transparent)
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a double value for each channel with range 0.0 to 1.0.

See also:

DynaPDFTableMBS.SetBackColorFloat(Row as Integer, Column as Integer, paramarray channels as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the back color of the table, a row or cells.
Example
dim pdf as DynaPDFMBS // your PDF environment
dim tbl as DynaPDFTableMBS = pdf.CreateTable(3, 3, 500.0, 20.0) // make some table

// now fill all rows and columns with RGB red specified by double values
const allRows = -1
const allColumns = -1
call tbl.SetBackColorFloat(allRows, allColumns, 1.0, 0.0, 0.0)

Default is none (transparent)
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a double value for each channel with range 0.0 to 1.0.

See also:

DynaPDFTableMBS.SetBackColorValue(Row as Integer, Column as Integer, TPDFColorSpace as Integer, ColorValue as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the back color of the table, a row or cells.
Example
dim pdf as DynaPDFMBS // your PDF environment
dim tbl as DynaPDFTableMBS = pdf.CreateTable(3, 3, 500.0, 20.0) // make some table

// now fill all rows and columns with RGB red specified by RGB() call
const allRows = -1
const allColumns = -1

dim c as Integer = DynaPDFMBS.RGB(255, 0, 0)
call tbl.SetBackColorValue(allRows, allColumns, DynaPDFMBS.kcsDeviceRGB, c)

Default is none (transparent)
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a color space and a matching color value.
For example kcsDeviceRGB and RGB(r,g,b), kcsDeviceCMYK and CMYK(c,m,y,k) or kcsDeviceGray with gray color.

DynaPDFTableMBS.SetBorderColor(Row as Integer, Column as Integer, channels() as Integer, ExtColorSpace as Integer = 0, ColorSpaceHandle as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border color of the table, a row or cells.
Example
// set color in CMYK with cyan (255 = 100%)
Call tbl.SetBorderColor(-1, -1, Array(255, 0, 0, 0), pdf.kesDeviceCMYK)
Call tbl.SetBorderWidth(-1, -1, 2.0, 2.0, 2.0, 2.0)

Default is black.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass an integer for each channel with 0 to 255.

See also:

DynaPDFTableMBS.SetBorderColor(Row as Integer, Column as Integer, paramarray channels as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border color of the table, a row or cells.
Example
const AllRows = -1
const AllColumns = -1

// set gray color for all borders to RGB(100,100,100)
call tbl.SetBorderColor(AllRows, AllColumns, 100, 100, 100)

// set border for all cells with fine line
call table.SetBorderWidth(AllRows, AllColumns, 0.5, 0.5, 0.5, 0.5)

Default is black.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass an integer for each channel with 0 to 255.

See also:

DynaPDFTableMBS.SetBorderColorFloat(Row as Integer, Column as Integer, channels() as Double, ExtColorSpace as Integer = 0, ColorSpaceHandle as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border color of the table, a row or cells.
Example
// set color in CMYK with magenta (1.0 = 100%)
Call tbl.SetBorderColorFloat(-1, -1, Array(0.0, 1.0, 0.0, 0.0), pdf.kesDeviceCMYK)
Call tbl.SetBorderWidth(-1, -1, 2.0, 2.0, 2.0, 2.0)

Default is black.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a double value for each channel with range 0.0 to 1.0.

See also:

DynaPDFTableMBS.SetBorderColorFloat(Row as Integer, Column as Integer, paramarray channels as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border color of the table, a row or cells.
Example
// set color in RGB with blue (1.0 = 100%)
Call tbl.SetBorderColorFloat(-1, -1, 0.0, 0.0, 1.0)
Call tbl.SetBorderWidth(-1, -1, 2.0, 2.0, 2.0, 2.0)

Default is black.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a double value for each channel with range 0.0 to 1.0.

See also:

DynaPDFTableMBS.SetBorderColorValue(Row as Integer, Column as Integer, TPDFColorSpace as Integer, ColorValue as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border color of the table, a row or cells.
Example
// set color in CMYK with magenta (255 = 100%)
Call tbl.SetBorderColorValue(-1, -1, pdf.kesDeviceCMYK, pdf.CMYK(0, 255, 0, 0))
Call tbl.SetBorderWidth(-1, -1, 2.0, 2.0, 2.0, 2.0)

// set color in RGB with green (255 = 100%)
Call tbl.SetBorderColorValue(row, -1, pdf.kesDeviceRGB, pdf.RGB(0, 255, 0))
Call tbl.SetBorderWidth(row, -1, 2.0, 2.0, 2.0, 2.0)

Default is black.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Pass a color space and a matching color value.
For example kcsDeviceRGB and RGB(r,g,b), kcsDeviceCMYK and CMYK(c,m,y,k) or kcsDeviceGray with gray color.

DynaPDFTableMBS.SetBorderWidth(Row as Integer, Column as Integer, left as Double, top as Double, right as Double, bottom as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the border width of the table, a row or cells.
Example
// set border for a row to right/bottom with fine line
call table.SetBorderWidth(rowNum, -1, 0.0, 0.0, 0.5, 0.5)

Default value is 0.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Some examples using this method:

DynaPDFTableMBS.SetCellAction(Row as Integer, Column as Integer, ActionHandle as UInt32, Mode as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates an invisible link annotation for the specified cell or table and associates the provided action with that annotation.

The result is an interactive area that executes the action if the user clicks on cell or table.
A cell action is always a background object that is created in the size of the background area when the table is drawn.

Unlike other cell objects like images, text, and so on, a cell link is no persistent object because the action will be deleted when then PDF file in memory will be closed or when destructor will be called.
If the table should be drawn into more than one PDF file then re-create the actions and cell action before drawing the table into the next PDF file.

Actions can be created with functions like CreateGoToAction(), CreateGoToRAction(), and so on.

If the function succeeds the return value is true. If the function fails the return value is false.

See also SetCellAction function in DynaPDF manual.

DynaPDFTableMBS.SetCellDashPattern(Row as Integer, Column as Integer, CellSide as Integer, LineCapStyle as Integer, values() as Double, Phase as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 20.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply a line dash pattern to cell, row, and table borders.

Pass kcsTop, kcsBottom, kcsLeft or kcsRight for CellSide parameter.

See also SetCellDashPattern function in DynaPDF manual.

DynaPDFTableMBS.SetCellImageData(Row as Integer, Column as Integer, ForeGround as boolean, HAlign as Integer, VAlign as Integer, Width as Double, Height as Double, ImageData as MemoryBlock, index as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets cell image.
Example
dim PictureData as memoryblock // from database maybe?
dim w as Double = 300 // destination size
dim h as Double = 200
dim row as Integer
dim column as Integer

dim table as DynaPDFTableMBS // your table

call table.SetCellImageData(row, column, true, table.kcoCenter, table.kcoCenter, w, h, PictureData, 0)

Returns true on success.

See also:

DynaPDFTableMBS.SetCellImageData(Row as Integer, Column as Integer, ForeGround as boolean, HAlign as Integer, VAlign as Integer, Width as Double, Height as Double, ImageData as string, index as Integer = 0) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets cell image.
Example
dim PictureData as string // from database maybe?
dim w as Double = 300 // destination size
dim h as Double = 200
dim row as Integer
dim column as Integer

dim table as DynaPDFTableMBS // your table

call table.SetCellImageData(row, column, true, table.kcoCenter, table.kcoCenter, w, h, PictureData, 0)

See also:

DynaPDFTableMBS.SetCellOrientation(Row as Integer, Column as Integer, Orientation as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function sets the cell orientation.

See dynapdf_help.pdf for details.

Some examples using this method:

See also SetCellOrientation function in DynaPDF manual.

DynaPDFTableMBS.SetCellPadding(Row as Integer, Column as Integer, left as Double, top as Double, right as Double, bottom as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the cell padding of the table, a row or cells.

Default is zero.
If Row is -1, all rows are modified. If Column is -1, all columns are modified.

Some examples using this method:

Next items

The items on this page are in the following plugins: MBS DynaPDF Plugin.


The biggest plugin in space...