Interface IDynamicFormatsLayer

Provides the functionality for DynamicFormatsLayer.

Inherited Members
System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.ICollection.Count
System.Collections.ICollection.IsSynchronized
System.Collections.ICollection.SyncRoot
System.Collections.IEnumerable.GetEnumerator()
Namespace: Syncfusion.Windows.Forms.Edit.Interfaces
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public interface IDynamicFormatsLayer : ICollection, IEnumerable

Properties

Hidden

Gets a value indicating whether the layer is hidden or not.

Declaration
bool Hidden { get; }
Property Value
Type
System.Boolean

Item[CoordinatePoint]

Gets the dynamic formatting by parse point.

Declaration
IDynamicFormat this[CoordinatePoint point] { get; }
Parameters
Type Name Description
CoordinatePoint point
Property Value
Type
IDynamicFormat

Item[CoordinatePoint, CoordinatePoint]

Gets the list of dynamic formatting, that intercepts with given range.

Declaration
IList this[CoordinatePoint start, CoordinatePoint end] { get; }
Parameters
Type Name Description
CoordinatePoint start
CoordinatePoint end
Property Value
Type
System.Collections.IList

Item[Int32]

Gets the formatting by index.

Declaration
IDynamicFormat this[int index] { get; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
IDynamicFormat

Methods

Add(CoordinatePoint, CoordinatePoint, ISnippetFormat)

Creates a new dynamic format object and adds it to the list. All existing dynamic formatting in specified range will be deleted or trimmed.

Declaration
IDynamicFormat Add(CoordinatePoint start, CoordinatePoint end, ISnippetFormat format)
Parameters
Type Name Description
CoordinatePoint start

Starting positions.
CoordinatePoint end

End positions.
ISnippetFormat format

Format to be added.
Returns
Type Description
IDynamicFormat

Newly created format.

Clear()

Clears all formatting in layer.

Declaration
void Clear()

IndexOf(IDynamicFormat)

Returns index of the dynamic formatting.

Declaration
int IndexOf(IDynamicFormat format)
Parameters
Type Name Description
IDynamicFormat format

Formatting to be found.
Returns
Type Description
System.Int32

Index of the formatting in the internal list.

PointInLayer(CoordinatePoint, Boolean, Boolean)

Checks whether coordinate point belongs to current layer.

Declaration
bool PointInLayer(CoordinatePoint point, bool bIncludeBefore, bool bIncludeAfter)
Parameters
Type Name Description
CoordinatePoint point

Point to check.
System.Boolean bIncludeBefore

If true, point at the end of region is considered as belonging to layer.
System.Boolean bIncludeAfter

If true, point at the beginning of region is considered as belonging to layer.
Returns
Type Description
System.Boolean

Bool indicating whether given point belongs to current layer.

Remove(IDynamicFormat)

Removes the specified format from the collection.

Declaration
void Remove(IDynamicFormat format)
Parameters
Type Name Description
IDynamicFormat format

Formatting to be deleted.

Remove(CoordinatePoint, CoordinatePoint)

Removes all formatting in specified range.

Declaration
void Remove(CoordinatePoint start, CoordinatePoint end)
Parameters
Type Name Description
CoordinatePoint start

Start of the range.
CoordinatePoint end

End of the range.

RemoveAt(Int32)

Removes formatting by given index.

Declaration
void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

Index of the formatting to be removed.

Events

DataChanged

Occurs when data is changed within the layer.

Declaration
event EventHandler DataChanged
Event Type
Type
System.EventHandler

Extension Methods