Back to Devexpress

TcxCustomImageProperties Class

vcl-cximage-a342ce53.md

latest5.8 KB
Original Source

TcxCustomImageProperties Class

The base class for image editor appearance and behavior settings.

Declaration

delphi
TcxCustomImageProperties = class(
    TcxCustomEditProperties
)

Remarks

An image editor is designed to store and display an image. Users can open a context menu to manage and edit images.

Main API Members

The list below outlines key members of the TcxCustomImageProperties class that allow you to configure image editors.

Appearance Settings

CaptionSpecifies the caption visible when the editor displays no image.Center | FitMode

Allow you to position an image within an image editor.

Note

Zoom operations are available only if the FitMode property is set to ifmNormal.

ShowFocusRectSpecifies if an image editor displays the focus rectangle.

Content-Related APIs

ExifAutoRotationAllows you to explicitly enable or disable automatic image rotation based on EXIF metadata.GetGraphicClassReturns the image container type when the image editor is used as an in-place editor in a container control.GraphicClass

Specifies the active image container type.

Tip

We recommend that you set this property to TdxSmartImage to ensure that the image editor supports the same image formats as all other DevExpress components.

GraphicTransparencySpecifies if the background of the displayed image is transparent.OnGetGraphicClassOccurs when an in-place image editor determines the image container type.

User Interaction APIs

CustomFilter

Specifies the custom file type filter for image Open and Save As shell dialogs.

You can call an image editor’s LoadFromFile and SaveToFile procedures to display these shell dialogs.

OnAssignPictureAllows you to respond to a change made to the displayed image.OnClosePopupAllows you to execute custom code when a user closes the context menu.OnCustomClickAllows you to respond to a click on a custom menu item added to the context menu of an image editor.PopupMenuLayout

Allows you to customize the context menu of an image editor.

You can use this property to remove predefined menu items or add and configure a custom menu item.

ReadOnlyEnables or disables read-only mode.

General-Purpose API Members

AssignedValues | RestoreDefaultsAllow you to track the state of individual editor settings and reset them.BeginUpdate | EndUpdate | LockUpdate | DoUpdate | Update | Changed | ChangedLocked | DataChangedAllow you to manage image editor updates and avoid excessive redraw operations during batch editor setting changes.

Direct TcxCustomImageProperties Class References

The following public API members reference a TcxCustomImageProperties object:

TcxCustomImage.ActivePropertiesProvides access to active image editor settings.TcxCustomImage.PropertiesProvides access to image editor settings.

Terminal TcxCustomImageProperties Class Descendant

Do not use the TcxCustomImageProperties class directly. Use the following descendant instead:

TcxImagePropertiesStores image editor settings.

Inheritance

TObject TPersistent TInterfacedPersistent TcxInterfacedPersistent TcxCustomEditProperties TcxCustomImageProperties

See Also

TcxEditRepositoryImageItem Class

TcxCustomImageProperties Members

cxImage Unit