RiverSoftAVG Products Help

AsString

The AsString property is a read-only property which returns the list of token strings parsed from the stream. Usually, this is the exact strings parsed from the stream. However, if the parser chooses to, the string returned could be a beautified version of the strings. The intent is that the string should be reparsable by the parser to create the exact same list of tokens.
 

Tag

The tag property is intended for the interface user to assign whatever value they like to the tag. The tag should be cloned and assigned. A common use for the tag would be to assign the object that the object represents so that the object is available later.

The Tag property calls the     GetTag and     SetTag methods.

ValueCount

The ValueCount property returns the number of tokens in the list. Use the   Value and ValueCount property to iterate through all the tokens in the list.
 

Value[Integer]

The Value property provides access to each token in the list. Use Value to directly access a token in the list. Index identifies each token by its position in the list, where 0 is the first item, 1 is the second item, and so on. The Value property is the default property - this means that the name of the property can be omitted in code, and the subscript applied directly to the interface.
 

Add(IBaseStreamToken)

The Add method adds a token to the list. Call Add to add a token to the list. The Add method returns the Index where the new Item is located.

Append(IBaseStreamTokenList)

The Append method appends or adds the tokens in the List parameter to the current list. The tokens are added to the end of the current list. When tokens are added, the tokens are not duplicated so modifications to the tokens in the List parameter modify the appended tokens in the current list.

Assign(IInterface)

Overloaded. Attempts to copy the fields or data from AValue into the underlying object. If the AValue parameter is not of an interface type that is understood by the object, it should raise an exception. (Inherited from CommonInterfaces.ICloneable.)

Assign(TPersistent)

Overloaded. Attempts to copy the fields or data from source object into the underlying object. (Inherited from CommonInterfaces.ICloneable.)

AssignTo(TPersistent)

Attempts to copy the fields or data from the underlying object into the Destination object. (Inherited from CommonInterfaces.ICloneable.)

Clear

The Clear method empties the list of all tokens. Use Clear to delete all tokens from the list.
 

Clone

The Clone method is intended to return a copy of the interface object. It is up to the interface implementer whether the clone is a shallow or deep copy. Please refer to the other interface documentation. A common implementation of this method creates the underlying object and then calls the Assign method.

Note that this method returns an IInterface and may need to be cast in order to assign it to another variable of a descendant interface type.
 

Delete(Integer)

The Delete method removes the token at the position given by the Index parameter. Call Delete to remove the token at a specific position from the list. The index is zero-based, so the first token has an Index value of 0, the second token has an Index value of 1, and so on. Calling Delete moves up all items in the list that follow the deleted token, and reduces the   ValueCount.

Equals(IBaseStreamTokenList)

Overloaded. The Equals method returns TRUE if the List parameter's tokens equals the current list. Not only the number of tokens in the list must match, but also each IBaseStreamToken.Equals must return true. Otherwise, this method returns False.

Equals(TObject)

Overloaded.  The Equals method returns True if the AList object contains a list, where every item in the list equals the list in the IBaseStreamTokenList implementing list. Otherwise, False.

It is expected that the implementor of this interface would check the AList object to see if it was a TInterfaceList object and could be compared.
 

First

The First method returns the first token in the list. Call First to obtain the first token in the list.
 

Get(Integer)

Accessor method for the   Value property.

GetTag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method. (Inherited from CommonInterfaces.ICloneable.)

GetValueCount

Accessor method for the   ValueCount property.

get_AsString

Accessor method for the   AsString property.

get_Tag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method.

get_Value(Integer)

Accessor method for the   Value property.

get_ValueCount

Accessor method for the   ValueCount property.

IndexOf(IBaseStreamToken)

The IndexOf method returns the index of an token. Call IndexOf to obtain the index of an token. If the Item is not found, this method returns -1.
 

Insert(Integer,IBaseStreamToken)

The Insert method inserts a token into the list at a specified position. Call Insert to insert a token into the list. Item is the token to insert, and Index indicates the position (zero-offset) where the token should be added.
 

Last

The Last method returns the last token in the list. Call Last to obtain the last token in the list.
 

Put(Integer,IBaseStreamToken)

Accessor method for the   Value property.

Remove(IBaseStreamToken)

The Remove method deletes the first reference to the Item parameter (Token) from the     Value array. Call Remove to remove a specific item from the Value array when its index is unknown. The value returned is the index of the item in the Items array before it was removed. After an item is removed, all the items that follow it are moved up in index position and the     ValueCount is reduced by one.

If the     Value array contains more than one copy of the token, only the first copy is deleted.
 

SetTag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.
 (Inherited from CommonInterfaces.ICloneable.)

set_Tag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.

set_Value(Integer,IBaseStreamToken)

Accessor method for the   Value property.

ToString

The ToString function returns the list of token strings parsed from the stream. Usually, this is the exact strings parsed from the stream. However, if the parser chooses to, the string returned could be a beautified version of the strings. The intent is that the string should be reparsable by the parser to create the exact same list of tokens.