Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This structure contains position information for the candidate window.

Syntax

typedef struct _tagCANDIDATEFORM {
  DWORD 
dwIndex;
  DWORD 
dwStyle;
  POINT 
ptCurrentPos;
  RECT 
rcArea;
} CANDIDATEFORM;

Members

dwIndex

Candidate list identifier. dwIndexcan be zero for the first list, 1 for the second, and so on. The maximum index is 31.

dwStyle

Position style. The following table shows possible values for dwStyle.

Value Description

CFS_CANDIDATEPOS

Displays the upper-left corner of the candidate list window at the position given by ptCurrentPos. The coordinates are relative to the upper-left corner of the window that contains the list window, and are subject to adjustment by the system.

CFS_EXCLUDE

Excludes the candidate window from the area specified by rcArea. The ptCurrentPosmember specifies the coordinates of the current point of interest, typically the caret position.

ptCurrentPos

Coordinates of the upper-left corner of the candidate window or the caret position, depending on the value of dwStyle.

rcArea

Coordinates of the upper-left and lower-right corners of the exclusion area.

Remarks

In Japanese versions 1.0 and later, the ImmSetCandidateWindowfunction allows an index range from zero through 4 for the dwIndexmember of the CANDIDATEFORMstructure. In Windows CE 2.10 and later, an index range from zero through 3 is allowed.

Requirements

Header imm.h
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

ImmSetCandidateWindow

Other Resources

POINT
RECT