Back to Devexpress

IdxRichEditShape Members

vcl-dxrichedit-dot-nativeapi-dot-idxricheditshape-dot-underscore-members.md

latest12.9 KB
Original Source

IdxRichEditShape Members

Exposes a floating shape within the document’s shape collection.

Properties

NameDescription
FillProvides access to the floating shape’s background appearance settings.
HorizontalAlignmentSpecifies how the floating picture or text box is placed horizontally in relation to the selected document item.
LineProvides access to outline appearance settings of the floating picture or text box.
LockAspectRatioSpecifies if an end-user can change the floating shape’s aspect ratio by using the corner sizing handles or the Layout dialog.
MarginBottomSpecifies the bottom margin (in the parent document’s measurement units) between the floating shape’s bounding rectangle and the parent document’s text.
MarginLeftSpecifies the left margin (in the parent document’s measurement units) between the floating shape’s bounding rectangle and the parent document’s text.
MarginRightSpecifies the right margin (in the parent document’s measurement units) between the floating shape’s bounding rectangle and the parent document’s text.
MarginTopSpecifies the top margin (in the parent document’s measurement units) between the floating shape’s rectangle and the parent document’s text.
NameSpecifies a unique name of the floating shape within the parent document’s shape collection.
OffsetSpecifies the floating shape’s position offset (in the parent document’s measurement units) from a base document position.
OriginalSizeReturns the floating shape’s initial dimensions in the parent document’s measurement units.
PictureProvides access to the Office Image container that hosts the source bitmap of the floating shape (picture).
PictureUriSpecifies the hosted image‘s universal resource identifier.
RangeReturns the document range to which the floating shape is anchored.
RelativeHorizontalPositionSpecifies the type of the document item that serves as the floating shape’s base horizontal position.
RelativeVerticalPositionSpecifies the type of the document item that serves as the floating shape’s vertical position.
RotationAngleRotates the floating picture or text box.
ScaleXSpecifies the scale factor applied to the floating shape’s original width.
ScaleYSpecifies the scale factor applied to the floating shape’s original height.
SizeSpecifies the floating shape’s on-screen dimensions in the parent document’s measurement units.
TextBoxProvides access to the text box within the floating shape.
TextWrappingSpecifies how the floating picture or text box is positioned in relation to the “text” layer of the parent document.
VerticalAlignmentSpecifies how the floating picture or text box is placed vertically in relation to the selected document item.
ZOrderSpecifies the floating shape’s custom Z-order.

Methods

NameDescription
GetFillReturns the floating shape’s background fill settings.
GetHorizontalAlignment
GetLineReturns the floating shape’s outline appearance settings.
GetLockAspectRatio
GetMarginBottom
GetMarginLeft
GetMarginRight
GetMarginTop
GetName
GetOffsetReturns the floating shape’s position offset (in the parent document’s measurement units) from a base document position.
GetOriginalSizeReturns the floating shape’s initial dimensions in the parent document’s measurement units.
GetPictureProvides access to the Office Image container that hosts the floating picture’s source bitmap.
GetPictureUriReturns the hosted image’s universal resource identifier.
GetRangeReturns the anchor position of the floating picture or text box.
GetRelativeHorizontalPosition
GetRelativeVerticalPosition
GetRotationAngleReturns the floating shape’s rotation angle in degrees.
GetScaleXReturns the scale factor applied to the original width of the floating picture or text box.
GetScaleYReturns the scale factor applied to the original height of the floating picture or text box.
GetSizeReturns the on-screen dimensions (in the parent document’s measurement units) of the floating picture or text box.
GetTextBoxProvides access to the content and settings of a floating text box.
GetTextWrappingIdentifies how the floating picture or text box is positioned in relation to the parent document’s “text” layer.
GetVerticalAlignmentIdentifies how the floating picture or text box is positioned vertically in relation to the selected
GetZOrder
SetHorizontalAlignment(TdxRichEditShapeHorizontalAlignment)
SetLockAspectRatio(Boolean)
SetMarginBottom(Single)
SetMarginLeft(Single)
SetMarginRight(Single)
SetMarginTop(Single)
SetName(string)
SetOffset(TdxPointF)
SetPictureUri(string)Assigns the specified string as the hosted image’s universal resource identifier.
SetRelativeHorizontalPosition(TdxRichEditShapeRelativeHorizontalPosition)
SetRelativeVerticalPosition(TdxRichEditShapeRelativeVerticalPosition)
SetRotationAngle(Single)Rotates the floating picture or text box at the specified angle in degrees.
SetScaleX(Single)Scales the floating picture or text box horizontally.
SetScaleY(Single)Scales the floating picture or text box vertically.
SetSize(TdxSizeF)Resizes the floating picture or text box.
SetTextWrapping(TdxRichEditTextWrappingType)Changes the floating shape’s position in relation to the parent document’s “text” layer.
SetVerticalAlignment(TdxRichEditShapeVerticalAlignment)
SetZOrder(Integer)

See Also

IdxRichEditShape Interface

dxRichEdit.NativeApi Unit