Class DynamicFormat
Represents a class that provides special formating for selection, etc.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit.Implementation.Formatting
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public class DynamicFormat : IDynamicFormat, IComparable
Constructors
DynamicFormat(CoordinatePoint, CoordinatePoint, ISnippetFormat)
Initializes a new instance of the DynamicFormat class.
Declaration
public DynamicFormat(CoordinatePoint start, CoordinatePoint end, ISnippetFormat format)
Parameters
Type | Name | Description |
---|---|---|
CoordinatePoint | start | Start point. |
CoordinatePoint | end | End point. |
ISnippetFormat | format | Format to be used. |
Properties
DefaultEndComparer
Gets the default comparer for dynamic formats.
Declaration
public static IComparer DefaultEndComparer { get; }
Property Value
Type |
---|
System.Collections.IComparer |
DefaultStartComparer
Gets the default comparer for dynamic formats.
Declaration
public static IComparer DefaultStartComparer { get; }
Property Value
Type |
---|
System.Collections.IComparer |
End
Gets or sets the end point.
Declaration
public CoordinatePoint End { get; set; }
Property Value
Type |
---|
CoordinatePoint |
EndDeleted
Gets or sets a value indicating whether the end point has been deleted.
Declaration
public bool EndDeleted { get; set; }
Property Value
Type |
---|
System.Boolean |
EndOffset
Gets or sets the offset of end coordinate point that are used for creating new point after the old one is deleted.
Declaration
public long EndOffset { get; set; }
Property Value
Type |
---|
System.Int64 |
Format
Gets or sets format to be used.
Declaration
public ISnippetFormat Format { get; set; }
Property Value
Type |
---|
ISnippetFormat |
Start
Gets or sets the start point.
Declaration
public CoordinatePoint Start { get; set; }
Property Value
Type |
---|
CoordinatePoint |
StartDeleted
Gets or sets a value indicating whether the start point has been deleted.
Declaration
public bool StartDeleted { get; set; }
Property Value
Type |
---|
System.Boolean |
StartOffset
Gets or sets the offset of start coordinate point that are used for creating new point after the old one is deleted.
Declaration
public long StartOffset { get; set; }
Property Value
Type |
---|
System.Int64 |
Methods
CompareTo(Object)
Compares current DynamicFormat with other DynamicFormat.
Declaration
public int CompareTo(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | ParsePoint |
Returns
Type | Description |
---|---|
System.Int32 | A 32-bit signed integer that indicates the relative order of the objects being compared. |
UpdateState()
Checks the state of start and end points of format and reassigns it when needed.
Declaration
public bool UpdateState()
Returns
Type | Description |
---|---|
System.Boolean | True if format has been successfully updated. False if format can't be updated and must be deleed. |
Events
BeforeEndReassigned
Occurred after end point is reassigned.
Declaration
public event EventHandler BeforeEndReassigned
Event Type
Type |
---|
System.EventHandler |
BeforeStartReassigned
Occurred after start point is reassigned.
Declaration
public event EventHandler BeforeStartReassigned
Event Type
Type |
---|
System.EventHandler |
EndReassigned
Occurred before end point is reassigned.
Declaration
public event EventHandler EndReassigned
Event Type
Type |
---|
System.EventHandler |
StartReassigned
Occurred before start point is reassigned.
Declaration
public event EventHandler StartReassigned
Event Type
Type |
---|
System.EventHandler |