Class ListViewControl

Represents a Windows list view control, which displays a collection of items that can be displayed using one of four different views. Wraps the System.Windows.Forms.ListView control.

Inheritance
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Base
ComponentBase
DialogComponentBase
DialogControl
ListViewControl
Implements
Inherited Members
FastReport.ComponentBase.CheckNegativeSize(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.DrawDragAcceptFrame(FastReport.Utils.FRPaintEventArgs, System.Drawing.Color)
FastReport.ComponentBase.GetPreferredSize()
FastReport.ComponentBase.GetSmartTag()
FastReport.ComponentBase.HandleDoubleClick()
FastReport.ComponentBase.HandleDragDrop(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleDragOver(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleKeyDown(System.Windows.Forms.Control, System.Windows.Forms.KeyEventArgs)
FastReport.ComponentBase.HandleMouseDown(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseHover(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseMove(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseUp(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.HandleMouseWheel(FastReport.Utils.FRMouseEventArgs)
FastReport.ComponentBase.PointInObject(System.Drawing.PointF)
FastReport.ComponentBase.DrawSelectionPoint(FastReport.Utils.FRPaintEventArgs, System.Drawing.Pen, System.Drawing.Brush, System.Single, System.Single)
FastReport.ComponentBase.PointInSelectionPoint(System.Single, System.Single, System.Drawing.PointF)
FastReport.Base.IsSelected
FastReport.Base.IsParentSelected
FastReport.Base.Delete()
FastReport.Base.OnAfterInsert(FastReport.InsertFrom)
FastReport.Base.SelectionChanged()
FastReport.Base.GetImageIndex()
Namespace: FastReport.Dialog
Assembly: FastReport.dll
Syntax
public class ListViewControl : DialogControl, IComponent, IDisposable, IFRSerializable, IHasEditor

Constructors

ListViewControl()

Initializes a new instance of the ListViewControl class with default settings.

Declaration
public ListViewControl()

Properties

CheckBoxes

Gets or sets a value indicating whether a check box appears next to each item in the control. Wraps the System.Windows.Forms.ListView.CheckBoxes property.

Declaration
public bool CheckBoxes { get; set; }
Property Value
Type Description
System.Boolean

CheckedIndices

Gets the indexes of the currently checked items in the control. Wraps the System.Windows.Forms.ListView.CheckedIndices property.

Declaration
[Browsable(false)]
public ListView.CheckedIndexCollection CheckedIndices { get; }
Property Value
Type Description
System.Windows.Forms.ListView.CheckedIndexCollection

CheckedItems

Gets the currently checked items in the control. Wraps the System.Windows.Forms.ListView.CheckedItems property.

Declaration
[Browsable(false)]
public ListView.CheckedListViewItemCollection CheckedItems { get; }
Property Value
Type Description
System.Windows.Forms.ListView.CheckedListViewItemCollection

Columns

Gets the collection of all column headers that appear in the control. Wraps the System.Windows.Forms.ListView.Columns property.

Declaration
[Browsable(false)]
public ListView.ColumnHeaderCollection Columns { get; }
Property Value
Type Description
System.Windows.Forms.ListView.ColumnHeaderCollection

Groups

Gets the collection of ListViewGroup objects assigned to the control. Wraps the System.Windows.Forms.ListView.Groups property.

Declaration
[Browsable(false)]
public ListViewGroupCollection Groups { get; }
Property Value
Type Description
System.Windows.Forms.ListViewGroupCollection

ItemCheckedEvent

Gets or sets a script method name that will be used to handle the ItemChecked event.

Declaration
public string ItemCheckedEvent { get; set; }
Property Value
Type Description
System.String

Items

Gets a collection containing all items in the control. Wraps the System.Windows.Forms.ListView.Items property.

Declaration
[Browsable(false)]
public ListView.ListViewItemCollection Items { get; }
Property Value
Type Description
System.Windows.Forms.ListView.ListViewItemCollection

LargeImageList

Gets or sets the ImageList to use when displaying items as large icons in the control. Wraps the System.Windows.Forms.ListView.LargeImageList property.

Declaration
[Browsable(false)]
public ImageList LargeImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

ListView

Gets an internal ListView.

Declaration
[Browsable(false)]
public ListView ListView { get; }
Property Value
Type Description
System.Windows.Forms.ListView

MultiSelect

Gets or sets a value indicating whether multiple items can be selected. Wraps the System.Windows.Forms.ListView.MultiSelect property.

Declaration
public bool MultiSelect { get; set; }
Property Value
Type Description
System.Boolean

SelectedIndexChangedEvent

Gets or sets a script method name that will be used to handle the SelectedIndexChanged event.

Declaration
public string SelectedIndexChangedEvent { get; set; }
Property Value
Type Description
System.String

SelectedIndices

Gets the indexes of the selected items in the control. Wraps the System.Windows.Forms.ListView.SelectedIndices property.

Declaration
[Browsable(false)]
public ListView.SelectedIndexCollection SelectedIndices { get; }
Property Value
Type Description
System.Windows.Forms.ListView.SelectedIndexCollection

SelectedItems

Gets the items that are selected in the control. Wraps the System.Windows.Forms.ListView.SelectedItems property.

Declaration
[Browsable(false)]
public ListView.SelectedListViewItemCollection SelectedItems { get; }
Property Value
Type Description
System.Windows.Forms.ListView.SelectedListViewItemCollection

ShowGroups

Gets or sets a value indicating whether items are displayed in groups. Wraps the System.Windows.Forms.ListView.ShowGroups property.

Declaration
public bool ShowGroups { get; set; }
Property Value
Type Description
System.Boolean

SmallImageList

Gets or sets the ImageList to use when displaying items as small icons in the control. Wraps the System.Windows.Forms.ListView.SmallImageList property.

Declaration
[Browsable(false)]
public ImageList SmallImageList { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageList

Text

This property is not relevant to this class.

Declaration
[Browsable(false)]
public override string Text { get; set; }
Property Value
Type Description
System.String
Overrides

View

Gets or sets how items are displayed in the control. Wraps the System.Windows.Forms.ListView.View property.

Declaration
public View View { get; set; }
Property Value
Type Description
System.Windows.Forms.View

Methods

AttachEvents()

Attaches Control events to its event handlers.

Declaration
protected override void AttachEvents()
Overrides
Remarks

Override this method if your custom control has own events.

DetachEvents()

Detaches Control events from its event handlers.

Declaration
protected override void DetachEvents()
Overrides
Remarks

Override this method if your custom control has own events. In this method, you should detach control's events that were attached in the AttachEvents() method.

OnItemChecked(ItemCheckedEventArgs)

This method fires the ItemChecked event and the script code connected to the ItemCheckedEvent.

Declaration
public virtual void OnItemChecked(ItemCheckedEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ItemCheckedEventArgs e

Event data.

OnSelectedIndexChanged(EventArgs)

This method fires the SelectedIndexChanged event and the script code connected to the SelectedIndexChangedEvent.

Declaration
public virtual void OnSelectedIndexChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Event data.

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

ShouldSerializeBackColor()

Determines whether is necessary to serialize the BackColor property.

Declaration
protected override bool ShouldSerializeBackColor()
Returns
Type Description
System.Boolean

true if serialization is necessary.
Overrides

ShouldSerializeForeColor()

Determines whether is necessary to serialize the ForeColor property.

Declaration
protected override bool ShouldSerializeForeColor()
Returns
Type Description
System.Boolean

true if serialization is necessary.
Overrides

Events

ItemChecked

Occurs when the checked state of an item changes. Wraps the System.Windows.Forms.ListView.ItemChecked event.

Declaration
public event ItemCheckedEventHandler ItemChecked
Event Type
Type Description
System.Windows.Forms.ItemCheckedEventHandler

SelectedIndexChanged

Occurs when the index of the selected item in the list view control changes. Wraps the System.Windows.Forms.ListView.SelectedIndexChanged event.

Declaration
public event EventHandler SelectedIndexChanged
Event Type
Type Description
System.EventHandler

Implements