Interface IEditableLineSizeHost

A collection that manages lines with varying height and hidden state. It has properties for header and footer lines, total line count, default size of a line and also lets you add nested collections. Methods are provided for changing the values and getting the total extent.

Inherited Members
Namespace: Syncfusion.GridCommon.ScrollAxis
Assembly: Syncfusion.GridCommon.Portable.dll
Syntax
public interface IEditableLineSizeHost : ILineSizeHost, IDisposable

Properties

DefaultLineSize

Gets or sets the default size of lines.

Declaration
double DefaultLineSize { get; set; }
Property Value
Type Description
System.Double

The default size of lines.

FooterLineCount

Gets or sets the footer line count.

Declaration
int FooterLineCount { get; set; }
Property Value
Type Description
System.Int32

The footer line count.

HeaderLineCount

Gets or sets the header line count.

Declaration
int HeaderLineCount { get; set; }
Property Value
Type Description
System.Int32

The header line count.

Item[Int32]

Gets or sets the line size at the specified index.

Declaration
double this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index

index value
Property Value
Type Description
System.Double

The line size at the specified index.

LineCount

Gets or sets the line count.

Declaration
int LineCount { get; set; }
Property Value
Type Description
System.Int32

The line count.

SupportsInsertRemove

Gets a value indicating whether the host supports inserting and removing lines.

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

The boolean value indicating whether the host supports inserting and removing lines.

SupportsNestedLines

Gets a value indicating whether the host supports nesting or not.

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

A boolean value indicating whether the host supports nesting.

TotalExtent

Gets the total extent which is the total of all line sizes. Note: This property only works if the DistanceCounterCollection has been setup for pixel scrolling, otherwise it returns System.Double.NaN.

Declaration
double TotalExtent { get; }
Property Value
Type Description
System.Double

The total extent which is the total of all line sizes or System.Double.NaN.

Methods

CreateMoveLines()

Creates the object which holds temporary state when moving lines.

Declaration
IEditableLineSizeHost CreateMoveLines()
Returns
Type Description
IEditableLineSizeHost

The object which holds temporary state when moving lines.

GetNestedLines(Int32)

Gets the nested lines at the given index.

Declaration
IEditableLineSizeHost GetNestedLines(int index)
Parameters
Type Name Description
System.Int32 index

The index at which the nested lines is to be obtained.
Returns
Type Description
IEditableLineSizeHost

The IEditableLineSizeHost representing the nested lines.

InsertLines(Int32, Int32, IEditableLineSizeHost)

Insert the given number of lines at the given index.

Declaration
void InsertLines(int insertAtLine, int count, IEditableLineSizeHost moveLines)
Parameters
Type Name Description
System.Int32 insertAtLine

The index of the first line to insert.
System.Int32 count

The count of the lines to be inserted.
IEditableLineSizeHost moveLines

A container with saved state from a preceding RemoveLines(Int32, Int32, IEditableLineSizeHost) call when lines should be moved. When it is null, empty lines with default size are inserted.

RemoveLines(Int32, Int32, IEditableLineSizeHost)

Removes a number of lines at the given index.

Declaration
void RemoveLines(int removeAtLine, int count, IEditableLineSizeHost moveLines)
Parameters
Type Name Description
System.Int32 removeAtLine

The index of the first line to be removed.
System.Int32 count

The count of the lines to be removed.
IEditableLineSizeHost moveLines

A container to save state for a subsequent InsertLines(Int32, Int32, IEditableLineSizeHost) call when lines should be moved.

SetHidden(Int32, Int32, Boolean)

Sets the hidden state for the given range of lines.

Declaration
void SetHidden(int from, int to, bool hide)
Parameters
Type Name Description
System.Int32 from

The start index of the line for which the hidden state to be set.
System.Int32 to

The end index of the line for which the hidden state to be set.
System.Boolean hide

A boolean value indicating whether to hide the lines. If set to true hide the lines.

SetNestedLines(Int32, IEditableLineSizeHost)

Sets the nested lines at the given index.

Declaration
void SetNestedLines(int index, IEditableLineSizeHost nestedLines)
Parameters
Type Name Description
System.Int32 index

The index at which the nested lines is to be added.
IEditableLineSizeHost nestedLines

The nested lines to be added. If parameter is null the line will be converted to a normal (not nested) line with default line size.

SetRange(Int32, Int32, Double)

Sets the line size for the range of lines.

Declaration
void SetRange(int from, int to, double size)
Parameters
Type Name Description
System.Int32 from

The start index of the line for which the line size is to be set.
System.Int32 to

The end index of the line for which the line size is to be set.
System.Double size

The line size to be set to the given range of lines.