Skip to main content

CaptionOffset Property

The caption offset within the control's bounds.

Definition​

Property "OLE.CaptionOffset" as Record

Values​

This property has the following record structure:

PosNameTypeDescriptionDefault
<1>Vertical OffsetIntegerOffsets the caption down a given number of pixels0
<2>Horizontal OffsetIntegerOffsets the caption right a given number of pixels0

Remarks​

The CaptionOffset property offsets the caption by a given number of pixels. This multivalued property has two fields: vertical offset and horizontal offset. Each offset is an integer value. Positive values will move the caption right and down while negative values move the caption up and right.

The offset is applied after the caption is positioned according to the CaptionAlignment is set.

Example​

// position the caption 10 pixels from the top left
Set_Property(@Window:".OLE_PICTURE", "OLE.CaptionAlignment", "Top":@FM:"Left")
Set_Property(@Window:".OLE_PICTURE", "OLE.CaptionOffset", "10":@FM:"10")

// position the caption 10 pixels from the bottom right
Set_Property(@Window:".OLE_PICTURE", "OLE.CaptionAlignment", "Bottom":@FM:"Right")
Set_Property(@Window:".OLE_PICTURE", "OLE.CaptionOffset", "-10":@FM:"-10")

See Also​

ImageOffset, CaptionAlignment