Bidi.OptionStreaming Field
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
This constant will be removed in the future version. Use Android.Icu.Text.BidiOptions enum directly instead of this field.
Option bit for setReorderingOptions:
process the output as part of a stream to be continued
[Android.Runtime.Register("OPTION_STREAMING", ApiSince=29)]
[System.Obsolete("This constant will be removed in the future version. Use Android.Icu.Text.BidiOptions enum directly instead of this field.", true)]
public const Android.Icu.Text.BidiOptions OptionStreaming = 4;[<Android.Runtime.Register("OPTION_STREAMING", ApiSince=29)>]
[<System.Obsolete("This constant will be removed in the future version. Use Android.Icu.Text.BidiOptions enum directly instead of this field.", true)>]
val mutable OptionStreaming : Android.Icu.Text.BidiOptionsField Value
Value = 4- Attributes
Remarks
Option bit for setReorderingOptions: process the output as part of a stream to be continued
This option must be set or reset before calling setPara.
This option specifies that the caller is interested in processing large text object in parts. The results of the successive calls are expected to be concatenated by the caller. Only the call for the last part will have this option bit off.
When this option bit is on, setPara() may process less than the full source text in order to truncate the text at a meaningful boundary. The caller should call getProcessedLength() immediately after calling setPara() in order to determine how much of the source text has been processed. Source text beyond that length should be resubmitted in following calls to setPara. The processed length may be less than the length of the source text if a character preceding the last character of the source text constitutes a reasonable boundary (like a block separator) for text to be continued.<br> If the last character of the source text constitutes a reasonable boundary, the whole text will be processed at once.<br> If nowhere in the source text there exists such a reasonable boundary, the processed length will be zero.<br> The caller should check for such an occurrence and do one of the following: <ul><li>submit a larger amount of text with a better chance to include a reasonable boundary.</li> <li>resubmit the same text after turning off option OPTION_STREAMING.</li></ul> In all cases, this option should be turned off before processing the last part of the text.
When the OPTION_STREAMING option is used, it is recommended to call orderParagraphsLTR(true) before calling setPara() so that later paragraphs may be concatenated to previous paragraphs on the right.
Java documentation for android.icu.text.Bidi.OPTION_STREAMING.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.