RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > RSGenerics.Collections > Classes

TObjectStringList<T> Class

Scroll Prev Top Next More

Extends the generics-based TStringList<T> for data <T> that are constrained to be classes.

The OwnsData property controls whether the data is freed when the string is deleted.

Namespace: RSGenerics.Collections

Type Parameters

Name

Description

public constructor

Create

Overloaded. Creates the generics string list. (Inherited from RSGenerics.Collections.TStringList<T>.)

public constructor

Create(Boolean)

Overloaded. Creates the generics string list and sets the RSGenerics.Collections.TStringList<T>.OwnsObjects property to the input.

The OwnsObjects property controls whether the TStringList<T> automatically frees its associated Objects.

Top

Name

Description

protected property

Assigning

Specifies whether the list is being assigned to or not. (Inherited from RSGenerics.Collections.TStringList<T>.)

public property

CaseSensitive

Controls whether strings are located, sorted, and identified as duplicates in a case-sensitive or case-insensitive manner.

Use CaseSensitive to indicate whether strings in the list should be compared in a case-sensitive or case-insensitive manner. Set CaseSensitive to True to make the string list locate, check for duplicates, and sort its strings in a case-sensitive manner. Set CaseSensitive to False to make the string list perform these operations case-insensitively.

Note
By default, the CaseSensitive property is set to False.

public property

DataValues

Returns the TValueCollection that is used to create enumerators (Inherited from RSGenerics.Collections.TStringList<T>.)

public property

Data[Integer]

Specifies the generic item that is associated with the string and object given by the Index parameter. (Inherited from RSGenerics.Collections.TStringList<T>.)

public property

Duplicates

Specifies whether duplicate strings can be added to sorted lists.

Set Duplicates to specify what should happen when an attempt is made to add a duplicate string to a sorted list. The CaseSensitive property controls whether two strings are considered duplicates if they are identical except for differences in case.

The value of Duplicates should be one of the following.:

dupIgnore

Ignore attempts to add duplicate strings to the list.

dupError

raise an EStringListError exception when an attempt is made to add duplicate strings to the sorted list.

dupAccept

Permit duplicate strings in the sorted list.

(Inherited from RSGenerics.Collections.TStringList<T>.)

public property

OnChange

Occurs immediately after the list of strings changes.

Write an OnChange event handler to respond to changes in the list of strings. For example, if the string list is associated with a control, the OnChange event handler could tell the control to repaint itself whenever the content of the list changes.

Whenever strings in the list are added, deleted, moved, or modified, the following events take place:

• An OnChanging event occurs before the change.

• The strings are added, deleted, moved, or modified.

• An OnChange event occurs.

Note
OnChange occurs for every change made to the list, regardless of whether the application calls BeginUpdate and EndUpdate around a series of changes.

public property

OnChanging

Occurs immediately before the list of strings changes.

Write an OnChanging event handler to prepare for changes in the list of strings. For example, if the string list is associated with a control, the OnChanging event handler could tell the control to disable repaints until the RSGenerics.Collections.TStringList<T>.OnChange event is triggered, notifying the control that the list has finished changing.

Whenever strings in the list are added, deleted, moved, or modified, the following events take place:

• An OnChanging event occurs before the change.

• The strings are added, deleted, moved, or modified.

• An OnChange event occurs.

Note
OnChanging occurs for every change made to the list, regardless of whether the application calls BeginUpdate and EndUpdate around a series of changes.

public property

OwnsData

Controls whether the data is freed when a string is deleted.

public property

OwnsObjects

Specifies whether to free the associated Object when a string is deleted from the string list. (Inherited from RSGenerics.Collections.TStringList<T>.)

public property

Sorted

Specifies whether the strings in the list should be automatically sorted.

Set Sorted to true to cause the strings in the list to be automatically sorted in ascending order. Set Sorted to false to allow strings to remain where they are inserted. When Sorted is false, the strings in the list can be put in ascending order at any time by calling the Sort method.

When Sorted is true, do not use Insert to add strings to the list. Instead, use Add, which will insert the new strings in the appropriate position. When Sorted is false, use Insert to add strings to an arbitrary position in the list, or Add to add strings to the end of the list.

Note
The CaseSensitive property controls whether the strings in the list are sorted based on a case-sensitive or case-insensitive comparison. The sort order takes into account the locale of the system on which the application is running.

Top

Name

Description

public method

Add(string)

Represents method Add(string). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

AddObject(string,TObject)

Overloaded. Represents method AddObject(string,TObject). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

AddObject(string,TObject,T)

Overloaded. Adds a string to the list, and associates an object and a generic piece of data with the string.

Call AddObject to add a string and its associated object and generics item to the list. AddObject returns the index of the new string, object, and item.

Note
If OwnsObjects is false, the stringlist object does not own the objects you add this way. Objects added to the TStringList<T> object still exist even if the TStrings instance is destroyed. They must be explicitly destroyed by the application.

public method

AddStrings(TStrings)

Overloaded. Represents method AddStrings(TStrings). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

Assign(TPersistent)

Represents method Assign(TPersistent). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

Changed

Called when the string list is changed.

Calls the OnChange event handler.

protected method

Changing

Called when the string list is about to be changed.

Calls the OnChanging event handler.

public method

Clear

Represents method Clear. (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

CompareStrings(string,string)

Represents method CompareStrings(string,string). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

Delete(Integer)

Represents method Delete(Integer). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

DoClear

Clears the generics string list. (Overrides RSGenerics.Collections.TStringList<T>.DoClear.)

protected method

DoDelete(Integer)

Deletes the specified item, including the associated data, from the string list.

Index gives the position of the string, where 0 is the first string, 1 is the second string, and so on.

protected method

DoFinalize(TRSStringItemList,Integer,Integer)

Finalizes (uninitializes a dynamically-allocated variable) the array that holds the information in the string list. (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

DoMove(TRSStringItemList,Integer,Integer,Integer)

Overloaded. Moves an item (Count=1) or range of items (Count > 1) in the array from one index to another (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

DoMove(TRSStringItemList,TRSStringItemList,Integer,Integer,Integer)

Overloaded. Copies items from FromArray to ToArray (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

Exchange(Integer,Integer)

Represents method Exchange(Integer,Integer). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

Find(string,Integer)

Locates the index for a string in a sorted list and indicates whether a string with that value already exists in the list. Use Find to obtain the index in a sorted list where the string S should be added. If the string S already exists in the list, Find returns True. If the list does not contain S, Find returns False. The index where S should go is returned in the Index parameter. The value of Index is zero-based, where the first string has the index 0, the second string has the index 1, and so on.

Note
Only use Find with sorted lists. For unsorted lists, use the IndexOf method instead.

Tip
If the S string is not found (thus return value of Find is False) then Index is set to the index of the first string in the list that sorts immediately before or after S.

protected method

Get(Integer)

Represents method Get(Integer). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

GetCapacity

Represents method GetCapacity. (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

GetCount

Represents method GetCount. (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

GetData(Integer)

Returns the associated data for the specified item given its index.

GetData is the protected read implementation of the Data property.

protected method

GetObject(Integer)

Represents method GetObject(Integer). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

IndexOf(string)

Represents method IndexOf(string). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

IndexOfData(T)

Returns the index of the data item that equals the input AData parameter. If the data is not found, the function returns -1.

public method

Insert(Integer,string)

Represents method Insert(Integer,string). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

InsertItem(Integer,string,TObject)

Overloaded. Inserts a string into the list at the specified position, and associates it with an object.

Call InsertItem to insert the string S into the list at the position identified by Index, and associate it with the object AObject. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.

InsertItem is the protected implementation of the InsertObject method.

protected method

InsertItem(Integer,string,TObject,T)

Overloaded. Inserts a string into the list at the specified position, and associates it with an object and with a generic data item.

Call InsertItem to insert the string S into the list at the position identified by Index, and associate it with the object AObject and data AData. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.

InsertItem is the protected implementation of the InsertObject method.

public method

InsertObject(Integer,string,TObject)

Overloaded. Represents method InsertObject(Integer,string,TObject). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

InsertObject(Integer,string,TObject,T)

Overloaded. Inserts a string into the list at the specified position, and associates it with an object and an item.

Call InsertObject to insert the string S into the list at the position identified by Index, and associate it with the object AObject and item AData. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.

Note
If OwnsObjects is false, the stringlist object does not own the objects you add this way. Objects added to the TStringList<T> object still exist even if the TStrings instance is destroyed. They must be explicitly destroyed by the application.

protected method

Put(Integer,string)

Represents method Put(Integer,string). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

PutData(Integer,T)

Sets the associated data for the specified item given its index.

PutData is the protected write implementation of the Data property.

protected method

PutObject(Integer,TObject)

Represents method PutObject(Integer,TObject). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

QuickSort(Integer,Integer,TStringListSortCompare)

Overloaded. Represents method QuickSort(Integer,Integer,TStringListSortCompare). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

SetCapacity(Integer)

Represents method SetCapacity(Integer). (Inherited from RSGenerics.Collections.TStringList<T>.)

protected method

SetUpdateState(Boolean)

Represents method SetUpdateState(Boolean). (Inherited from RSGenerics.Collections.TStringList<T>.)

public method

Sort

Overloaded. Sorts the strings in the list in ascending order.

Call Sort to sort the strings in a list that has the Sorted property set to false. String lists with the Sorted property set to true are automatically sorted.

Note
Sort uses AnsiCompareStr to sort the strings when CaseSensitive is true and AnsiCompareText when CaseSensitive is false. To provide your own comparison operator instead, use the Sort method.

public method

Sort(TStringListSortCompare)

Overloaded. Sorts the strings in the list in a customized order.

Use Sort to sort the strings in the list, where the sort order is defined by the Compare parameter.

Supply a value for the Compare function that compares two strings in the string list. The List parameter provides access to the string list, while the Index1 and Index2 parameters identify the strings to be compared.

Do not pass nil (Delphi) or NULL (C++) as the value of the Compare parameter.

Note
You must explicitly call the Sort method. Setting the Sorted property only sorts strings using ANSI (Windows) or UTF-8 (Linux) order, as implemented in the Sort method.

protected method

StringListCompareStrings(TStringList<T>,Integer,Integer)

Returns the sort order (-1, 0, 1) for comparing two strings in the string list. (Inherited from RSGenerics.Collections.TStringList<T>.)

Top

	Name	Description
	FCount	Represents field FCount. (Inherited from RSGenerics.Collections.TStringList<T>.)
	FList	Represents field FList. (Inherited from RSGenerics.Collections.TStringList<T>.)
	FOwnsData	Represents field FOwnsData.

Top

RiverSoftAVG Products Help

Reference