Okapi .NET Library

IFilterItem.AppendCode Method 

 [This is preliminary documentation and subject to change.]

Appends an inline code to the text of the item.

[Visual Basic]
Sub AppendCode( _ 
   ByVal p_nType As Integer, _ 
   ByVal p_sLabel As String, _ 
   ByVal p_sData As String _ 
)
[C#]
void AppendCode(
   int p_nType,
   string p_sLabel,
   string p_sData
);
[C++]
void AppendCode(
   int p_nType,
   String* p_sLabel,
   String* p_sData
);
[JScript]
function AppendCode(
   int p_nType,
   String p_sLabel,
   String p_sData
);

Parameters

p_nType
Type of the inline code. The value must be one of the InlineCode values.
p_sLabel
Label of the inline code.
p_sData
Actual oode of the inline code.

Remarks

Use this method to add an inline code at the end of the current text. To add a character use the AppendChar method. To add a run of text use the AppendText method.

The p_sLabel parameter value is used to specified the type/name of the code (similar to the ctype attribute in XLIFF). For paired codes, you must specify the same label when appending the opening code and the closing code. The label must be the same for codes of the same kind (e.g. all <b>/<b> tags should be set to the same label). It must also be distinct for each kind of code (i.e. the <b> and <i> tags must have different labels. It is OK to use null if all the inline codes in the item are of the same kind.

See Also

IFilterItem Interface | Okapi.Library.Filter Namespace | AppendChar | AppendText