DocumentCapabilitiesOptions.FloatingObjects Property

Gets or sets the document’s capability to handle floating objects.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability FloatingObjects { get; set; }

VB.NET

<DefaultValue(DocumentCapability.Default)>
Public Overridable Property FloatingObjects As DocumentCapability

Property Value

Type	Default	Description
DocumentCapability	**Default**	A DocumentCapability enumeration specifying 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:

Library	Object Type	Path to FloatingObjects
WinForms Controls	SnapControlOptions	.DocumentCapabilities.FloatingObjects
	RichEditControlOptions	.DocumentCapabilities.FloatingObjects
WPF Controls	RichEditControlOptions	.DocumentCapabilities.FloatingObjects
Office File API	RichEditControlOptionsBase	.DocumentCapabilities.FloatingObjects
ASP.NET Web Forms Controls	ASPxRichEditSettings	.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. Use the DocumentCapabilitiesOptions.InlineShapes property to disable inline shapes.