[This is preliminary documentation and subject to change.]

Extract a part of the text from the item.

[Visual Basic]
Function Extract( _ 
   ByVal p_nStart As Integer, _ 
   ByVal p_nLength As Integer, _ 
   ByVal p_bAddMissingCodes As Boolean _ 
) As IFilterItem
[C#]
IFilterItem Extract(
   int p_nStart,
   int p_nLength,
   bool p_bAddMissingCodes
);
[C++]
IFilterItem* Extract(
   int p_nStart,
   int p_nLength,
   bool p_bAddMissingCodes
);
[JScript]
function Extract(
   int p_nStart,
   int p_nLength,
   bool p_bAddMissingCodes
): IFilterItem;

Parameters

p_nStart

Start position of the part to extract in the coded representation of the text.

p_nLength

Length of the part to extract in the coded representation of the text.

p_bAddMissingCodes

True if the missing codes creating when splitting the item are to be added as needed. False if the extra codes are simply to be changed to isolated codes.

Return Value

The new filter item containing a copy of the original one, with only the part of text to extract.

Remarks

Use this method to split a filter item. The inline codes in both the original item and the returned item are adjusted as needed. If the p_nStart is out of bounds, or if p_nLength is invalid the method returns null.

See Also

IFilterItem Interface | Okapi.Library.Filter Namespace

---