Navigation: Subroutines > XTEXT > XTEXT Parameters > txtctl

TXC.FLAGMASK

This 16 bit bitmap controls how the routine will interpret the TXC.FLAGS# fields. Because of the large number of flags, and the fact that some of them default to ON while others default to OFF, it is not practical for applications to have to consider and properly set/reset all of them. Instead, it is typically more convenient to force just a few individual flags ON, or OFF, or to replace a block of flags. These three modes are referred to "addition", "subtraction", and "replacement", respectively. In "addition mode", any bits set in the TXC.FLAGS# field will be added to the current or default flags for the control (i.e. forced ON or ENABLED). In "subtraction mode", any bits set in the TXC.FLAGS# field will be subtracted from the current settings (i.e. forced OFF or DISABLED). In "replacement mode", all of the flags corresponding to an entire 32 bit TXC.FLAGS# field are replaced (i.e. turned ON/OFF) according to the pattern of 1s and 0s in field.

The default mode is addition, meaning that to enable any individual flags, just set the corresponding bits in the TXC.FLAGS# fields. (The specified options will be enabled; all the other options corresponding to the 0s in the TXC.FLAGS# fields will be left in their current or default state.) To specify subtraction or replacement mode for any of the TXC.FLAGS# fields, set the TXC.FLAGMASK bitmap to a combination of bit patterns from the following table:

 

Example

TXC.flagmask = &h0410                                ! subtraction for TXC.flags3, replacement for TXC.flags5

TXC.flags1 = TXF1_METRIC or TXF1_HIDE_PAGE_BREAK     ! set these flags (addition)

TXC.flags3 = TXF3_EMBEDDED_TABLES or TXF3_NO_SCROLL  ! clear these flags  (subtraction)

TXC.flags5 = TXF5_GROUP_UNDO or TXF5_NO_KB_SEL       ! set these and clear all other TXF5_xxx flags (replacement)