| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
DynaPDF.Table.ClearContent
Deletes the specified object types from the table.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| DynaPDF | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.Table.ClearContent"; Table; Types ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| Table | The identifier for the table. | $Table |
| Types | What to clear. Can be Text, Template, Table, Action, ForeGround, BackGround, AllCont or Both. Or you pass numeric values combined from the hex values int he table below. | "AllCont" |
Result
Returns OK or error.
Description
Deletes the specified object types from the table.The parameter Types is a bit mask. The content types and the fore- and background flags can be combined with a binary or operator. If the foreground and background flags are both absent, then nothing will be deleted!
Other programming languages require no type cast.
Note that it is not required to explicitely clear the contents of a table. Existing contents can be overriden at any time. However, when it is not known whether all cells get new values, then it is recommended to clear the table beforehand.
It is also possible to clear the contents of specific rows or columns only. See DynaPDF.Table.ClearColumn and DynaPDF.Table.ClearRow for further information.
| Type | Hex Number | Description |
| Text | 0x00000001 | Text is always a foreground object |
| Image | 0x00000002 | Images |
| Template | 0x00000004 | Templates |
| Table | 0x00000008 | Sub tables are always foreground objects |
| AllCont | 0x0000001F | Delete all content types |
| ForeGround | 0x10000000 | Only foreground objects? |
| BackGround | 0x20000000 | Only background objects? |
| Both | 0x30000000 | Delete both fore- and background objects |
See also
This function checks for a license.
Created 18th August 2014, last changed 22nd February 2019
