Add(String,String,Boolean) Method

Adds a ListToolItem object to the collection with the specified property values.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function Add( _
   ByVal key As String, _
   ByVal text As String, _
   ByVal isChecked As Boolean _
) As ListToolItem

C#

public ListToolItem Add( 
   string key,
   string text,
   bool isChecked
)

Parameters

key

The unique Key value to assign to the ListToolItem being added.

text

The text that will be displayed for the ListToolItem being added.

isChecked

Specify True to check (select) the ListToolItem being added. This only applies when the DisplayCheckmark property of the ListTool is set to True.

Return Value

A newly created ListToolItem instance with the specified key which has been added to the collection.

Exceptions

Exception	Description
System.ArgumentException	key is null or empty.
System.ArgumentException	An item with a key of key already exists in the collection.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2