Back to Devexpress

DocumentCapabilitiesOptions.FloatingObjects Property

officefileapi-devexpress-dot-xtrarichedit-dot-documentcapabilitiesoptions-a3cdad4b.md

latest3.6 KB
Original Source

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.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability FloatingObjects { get; set; }
vb
<DefaultValue(DocumentCapability.Default)>
Public Overridable Property FloatingObjects As DocumentCapability

Property Value

TypeDefaultDescription
DocumentCapabilityDefault

An enumeration value that specifies the document’s capability to handle floating objects.

|

Available values:

NameDescription
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 TypePath to FloatingObjects
RichEditControlOptionsBase

.DocumentCapabilities .FloatingObjects

|

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.

See Also

Shapes, Pictures, and Other Graphic Objects in Rich Text Documents

DocumentCapabilitiesOptions Class

DocumentCapabilitiesOptions Members

DevExpress.XtraRichEdit Namespace