DocumentCapabilitiesOptions.FloatingObjects Property
Gets or sets the document’s capability to handle floating objects (shapes with any wrapping type but InLineWithText).
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v24.1.Core.dll
NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation
Declaration
[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability FloatingObjects { get; set; }
Property Value
Type | Default | Description |
---|---|---|
DocumentCapability | Default | An enumeration value that specifies the document’s capability to handle floating objects. |
Available values:
Name | Description |
---|---|
Default | The value is determined by the current setting. The default value is automatically set if it is not explicitly specified. |
Disabled | The feature is not allowed and the corresponding commands are shown disabled. |
Enabled | The feature is available and the corresponding commands are shown enabled. |
Hidden | The feature is not available and the corresponding commands are hidden. |
Property Paths
You can access this nested property as listed below:
Object Type | Path to FloatingObjects |
---|---|
RichEditControlOptionsBase |
|
Remarks
This property affects the behavior of InsertFloatingObjectPictureCommand and InsertTextBoxCommand commands, and the ability to handle floating objects in the document.
The DocumentCapability.Default value for the FloatingObjects property is equal to DocumentCapability.Enabled, so that floating objects can be displayed for a currently loaded document.
Note
The FloatingObjects
property does not affect the availability of inline shapes (shapes with Shape.TextWrapping set to InLineWithText). Use the DocumentCapabilitiesOptions.InlineShapes property to disable inline shapes.