Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

DynaPDF.Table.ClearContent

Deletes the specified object types from the table.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 3.5 Yes Yes Yes Yes Yes

MBS( "DynaPDF.Table.ClearContent"; Table; Types )

Parameters

Parameter Description Example value
Table The identifier for the table. $Table
Types What to clear. Can be Text, Template, Table, 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.

TypeHex NumberDescription
Text0x00000001Text is always a foreground object
Image0x00000002Images
Template0x00000004Templates
Table0x00000008Sub tables are always foreground objects
AllCont0x0000001FDelete all content types
ForeGround0x10000000Only foreground objects?
BackGround0x20000000Only background objects?
Both0x30000000Delete both fore- and background objects

See also


DynaPDF.Table.ClearColumn   -   DynaPDF.Table.ClearRow

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins