TF_STATUS structure

  • Article

The TF_STATUS structure contains document status data.

Syntax

typedef struct {
  DWORD dwDynamicFlags;
  DWORD dwStaticFlags;
} ;

Members

  • dwDynamicFlags
    Contains a set of flags that can be changed by an app at run time. For example, an app can enable a check box for the user to reset the status of documentation. This member can contain zero, or one or more of the following values.

    Value Meaning
    TF_SD_LOADING The document is loading.
    TF_SD_READONLY The document is read-only.
    TS_SD_UIINTEGRATIONENABLE Starting with Windows 8.1: The text control owning the document sets this flag to indicate its support of IME UI integration. When specified, the IME should attempt to align the candidate window below the text box instead of floating near the cursor.Note  Not all IMEs respond to this flag. IME candidate lists are positioned on the screen with sufficient size to allow basic text input. In some cases, the IME may enforce a reasonable minimum size. An IME might also choose to adjust the candidate window and keyboard input behavior to provide a better user experience, such as using a horizontal candidate list and allowing some keys such as up arrow and down arrow to be sent to the app for scenarios such as suggestion list navigation.
     
    TF_SD_TKBAUTOCORRECTENABLE Starting with Windows 8.1: The document supports autocorrection provided by the touch keyboard. This support can change during the lifetime of the control.
    TF_SD_TKBPREDICTIONENABLE Starting with Windows 8.1: The document supports text suggestions provided by the touch keyboard. This support can change during the lifetime of the control.

     

  • dwStaticFlags
    Contains a set of flags that cannot be changed at run time. This member can contain zero, or one or more of the following values.

    Value Meaning
    TF_SS_DISJOINTSEL The document supports multiple selections.
    TF_SS_REGIONS The document can contain multiple regions.
    TF_SS_TRANSITORY The document is expected to have a short usage cycle.
    TF_SS_TKBAUTOCORRECTENABLE Starting with Windows 8: The document supports autocorrection provided by the touch keyboard.
    TF_SS_TKBPREDICTIONENABLE Starting with Windows 8: The document supports text suggestions provided by the touch keyboard.

     

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

 Msctf.h

IDL

 Msctf.idl