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.Windows.Forms.CellGrid.ScrollAxis
Assembly: Syncfusion.Spreadsheet.Windows.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
Property Value
Type
System.Double

LineCount

Gets or sets the line count.

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

The line count.

SupportsInsertRemove

Gets whether the host supports inserting and removing lines.

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

SupportsNestedLines

Gets whether the host supports nesting.

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

TotalExtent

Gets the total extent which is the total of all line sizes. Note: This propert only works if the DistanceCollection has been setup for pixel scrolling; otherwise it returns double.NaN.

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

The total extent or double.NaN.

Methods

CreateMoveLines()

Creates the object which holds temporary state when moving lines.

Declaration
IEditableLineSizeHost CreateMoveLines()
Returns
Type
IEditableLineSizeHost

GetNestedLines(Int32)

Gets the nested lines.

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

The index.
Returns
Type
IEditableLineSizeHost

InsertLines(Int32, Int32, IEditableLineSizeHost)

Insert a number of lines.

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.
IEditableLineSizeHost moveLines

A container with saved state from a preceeding 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.

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.
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 a range of lines.

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

From.
System.Int32 to

To.
System.Boolean hide

if set to true hide the lines.

SetNestedLines(Int32, IEditableLineSizeHost)

Sets the nested lines.

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

The index.
IEditableLineSizeHost nestedLines

The nested lines.

SetRange(Int32, Int32, Double)

Sets the line size for a range.

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

From.
System.Int32 to

To.
System.Double size

The size.