RepositoryItemPictureEdit.OptionsMask Property

Provides access to settings that enable masked mode and allow you to customize the masked mode behavior.

Namespace : DevExpress.XtraEditors.Repository

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXCategory("Appearance")]
public PictureEditOptionsMask OptionsMask { get; }

<DXCategory("Appearance")>
Public ReadOnly Property OptionsMask As PictureEditOptionsMask

Property Value

Type	Description
PictureEditOptionsMask

An object whose settings allows you to enable masked mode and customize the masked mode behavior.

Remarks

The masked mode can be used to clip out a part of the image. Use the PictureEditOptionsMask.MaskType property to enable the Circle or RoundedRect predefined mask type, or apply a custom mask.

PictureEditMaskType.Circle -

A circle mask.

PictureEditMaskType.RoundedRect -

A rounded rectangle mask.

Use the PictureEditOptionsMask.RectCornerRadius property to specify the radius of rounded corners.

PictureEditMaskType.Custom -

Enables the use of a custom mask, assigned to the PictureEditOptionsMask.CustomMask property.

Settings provided by the OptionsMask object allow you to customize the mask layouting behavior and mask bounds, based on your requirements.

PictureEditOptionsMask.MaskLayoutMode - Gets or sets how a mask is aligned relative to the target image.
PictureEditOptionsMask.Size - Gets or sets a custom size for the mask.
PictureEditOptionsMask.Offset - Gets or sets the offset of the mask relative to the image.
PictureEditOptionsMask.Margin - Gets or sets the outer margin of the mask.