Bidi.WriteReordered(BidiOptions) Method
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.
Take a Bidi object containing the reordering
information for a piece of text (one or more paragraphs) set by
setPara() or for a line of text set by setLine()
and return a string containing the reordered text.
[Android.Runtime.Register("writeReordered", "(I)Ljava/lang/String;", "GetWriteReordered_IHandler", ApiSince=29)]
public virtual string? WriteReordered (Android.Icu.Text.BidiOptions options);[<Android.Runtime.Register("writeReordered", "(I)Ljava/lang/String;", "GetWriteReordered_IHandler", ApiSince=29)>]
abstract member WriteReordered : Android.Icu.Text.BidiOptions -> string
override this.WriteReordered : Android.Icu.Text.BidiOptions -> stringParameters
- options
- BidiOptions
A bit set of options for the reordering that control
how the reordered text is written.
The options include mirroring the characters on a code
point basis and inserting LRM characters, which is used
especially for transforming visually stored text
to logically stored text (although this is still an
imperfect implementation of an "inverse Bidi" algorithm
because it uses the "forward Bidi" algorithm at its core).
The available options are:
DO_MIRRORING,
INSERT_LRM_FOR_NUMERIC,
KEEP_BASE_COMBINING,
OUTPUT_REVERSE,
REMOVE_BIDI_CONTROLS,
STREAMING
Returns
The reordered text.
If the INSERT_LRM_FOR_NUMERIC option is set, then
the length of the returned string could be as large as
getLength()+2*countRuns().<br>
If the REMOVE_BIDI_CONTROLS option is set, then the
length of the returned string may be less than
getLength().<br>
If none of these options is set, then the length of the returned
string will be exactly getProcessedLength().
- Attributes
Remarks
Take a Bidi object containing the reordering information for a piece of text (one or more paragraphs) set by setPara() or for a line of text set by setLine() and return a string containing the reordered text.
The text may have been aliased (only a reference was stored without copying the contents), thus it must not have been modified since the setPara() call.
This method preserves the integrity of characters with multiple code units and (optionally) combining characters. Characters in RTL runs can be replaced by mirror-image characters in the returned string. Note that "real" mirroring has to be done in a rendering engine by glyph selection and that for many "mirrored" characters there are no Unicode characters as mirror-image equivalents. There are also options to insert or remove Bidi control characters; see the descriptions of the return value and the options parameter, and of the option bit flags.
Java documentation for android.icu.text.Bidi.writeReordered(int).
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.