Class LineItem

Represents a visual or logical unit within a structured layout, such as a row or entry in a WPF interface.

Inheritance

System.Object

LineItem

Namespace: Syncfusion.Windows.Edit

Assembly: Syncfusion.Edit.Wpf.dll

Syntax

public class LineItem : FrameworkElement

Constructors

LineItem()

Initializes a new instance of the LineItem class.

Declaration

public LineItem()

LineItem(String)

Initializes a new instance of the LineItem class.

Declaration

public LineItem(string text)

Parameters

Type	Name	Description
System.String	text

Fields

ContainsLinesProperty

DependencyProperty for ContainsLines

Declaration

public static readonly DependencyProperty ContainsLinesProperty

Field Value

Type
System.Windows.DependencyProperty

EndLineProperty

Gets or sets EndLine property

Declaration

public static readonly DependencyProperty EndLineProperty

Field Value

Type
System.Windows.DependencyProperty

IsEndLineProperty

Gets or sets IsEndLine Property

Declaration

public static readonly DependencyProperty IsEndLineProperty

Field Value

Type
System.Windows.DependencyProperty

IsExpandedProperty

DependencyProperty for IsExpanded

Declaration

public static readonly DependencyProperty IsExpandedProperty

Field Value

Type
System.Windows.DependencyProperty

LineNumberProperty

DependencyProperty for LineNumber

Declaration

public static readonly DependencyProperty LineNumberProperty

Field Value

Type
System.Windows.DependencyProperty

LineStateProperty

// Using a DependencyProperty as the backing store for LineState. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LineStateProperty

Field Value

Type
System.Windows.DependencyProperty

ParentLineNumberProperty

Gets or sets ParentLineNumber property

Declaration

public static readonly DependencyProperty ParentLineNumberProperty

Field Value

Type
System.Windows.DependencyProperty

StartLineProperty

Gets or sets StartLine property

Declaration

public static readonly DependencyProperty StartLineProperty

Field Value

Type
System.Windows.DependencyProperty

TextProperty

DependencyProperty for Text

Declaration

public static readonly DependencyProperty TextProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

ContainsLines

Gets or sets a value indicating whether ContainsLines contain child item.

Declaration

public bool ContainsLines { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean

EndLine

Gets or sets the EndLine

Declaration

public int EndLine { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

IsEndLine

Declaration

public bool IsEndLine { get; set; }

Property Value

Type
System.Boolean

IsExpanded

Gets or sets a value indicating whether the line is expanded or not

Declaration

public bool IsExpanded { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean

IsSelected

Gets or sets a value indicating whether the line is selected.

Declaration

public bool IsSelected { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean

LineNumber

Gets the line number of the text

Declaration

public int LineNumber { get; }

Property Value

Type	Description
System.Int32	Type: System.Int32

LineState

Declaration

public LineModificationState LineState { get; set; }

Property Value

Type
LineModificationState

ParentControl

Gets parent editcontrol

Declaration

public EditControl ParentControl { get; }

Property Value

Type	Description
EditControl	Type: Syncfusion.Windows.Edit.EditControl

ParentLineNumber

Gets or sets the ParentLineNumber

Declaration

public int ParentLineNumber { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

SelectionEndIndex

Gets or sets the End index of the text selection

Declaration

public int SelectionEndIndex { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

SelectionPath

Gets or sets the SelectionPath

Declaration

public RectangleGeometry SelectionPath { get; set; }

Property Value

Type
System.Windows.Media.RectangleGeometry

SelectionStartIndex

Gets or sets the Start index of the text selection in the line

Declaration

public int SelectionStartIndex { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

SetCursorIndex

Gets or sets the SetCursorIndex

Declaration

public int SetCursorIndex { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

SetCursorOnLoad

Gets or sets a value indicating whether the SetCursorOnLoad true or false.

Declaration

public bool SetCursorOnLoad { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean

StartLine

Gets or sets the StartLine

Declaration

public int StartLine { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32

Text

Gets or sets the Text in a line

Declaration

public string Text { get; set; }

Property Value

Type
System.String

TextWidth

Gets or sets width of the text in the line

Declaration

public double TextWidth { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double

VisualChildrenCount

Gets the number of visual child elements.

Declaration

protected override int VisualChildrenCount { get; }

Property Value

Type	Description
System.Int32	The number of visual child elements for this element.

Remarks

VisualChildrenCount is the Override method used to get the count of the visual child from the visual collection.

WordsCollection

Gets the WordsCollection

Declaration

public IList<WordDetails> WordsCollection { get; }

Property Value

Type	Description
System.Collections.Generic.IList<WordDetails>	Type: System.Int32

Methods

CopyExpandDetails(LineItem)

Declaration

public void CopyExpandDetails(LineItem item)

Parameters

Type	Name	Description
LineItem	item

GetLineItemExpandDetails()

Declaration

public LineItemExpandInformation GetLineItemExpandDetails()

Returns

Type
LineItemExpandInformation

GetVisualChild(Int32)

Overrides System.Windows.Media.Visual.GetVisualChild(System.Int32), and returns a child at the specified index from a collection of child elements.

Declaration

protected override Visual GetVisualChild(int index)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the requested child element in the collection.

Returns

Type	Description
System.Windows.Media.Visual	The requested child element. This should not return null; if the provided index is out of range, an exception is thrown.

Remarks

GetVisualChild is the Override method used to get the visual child from the visual collection based on the index value.

OnCreateAutomationPeer()

Creates and returns an automation peer for the LineItem control.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
System.Windows.Automation.Peers.AutomationPeer	A new instance of LineItemAutomationPeer associated with this control.

OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)

Declaration

protected override void OnPreviewMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e

ToString()

Declaration

public override string ToString()

Returns

Type
System.String