Edit

Share via

RICHEDIT_IMAGE_PARAMETERS structure (richedit.h)

  • Article

Defines the attributes of an image to be inserted by the EM_INSERTIMAGE message.

Syntax

typedef struct tagRICHEDIT_IMAGE_PARAMETERS {
  LONG    xWidth;
  LONG    yHeight;
  LONG    Ascent;
  LONG    Type;
  LPCWSTR pwszAlternateText;
  IStream *pIStream;
} RICHEDIT_IMAGE_PARAMETERS;

Members

xWidth

The width, in HIMETRIC units (0.01 mm), of the image.

yHeight

Ascent

If Type is TA_BASELINE, this parameter is the distance, in HIMETRIC units, that the top of the image extends above the text baseline. If Type is TA_BASELINE and ascent is zero, the bottom of the image is placed at the text baseline.

Type

The vertical alignment of the image. It can be one of the following values.

Value Meaning
TA_BASELINE
 Align the image relative to the text baseline.
TA_BOTTOM
 Align the bottom of the image at the bottom of the text line.
TA_TOP
 Align the top of the image at the top of the text line

pwszAlternateText

The alternate text for the image.

pIStream

The stream that contains the image data.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header richedit.h

See also

EM_INSERTIMAGE