Bidi.GetVisualMap 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.
Get a visual-to-logical index map (array) for the characters in the
Bidi
(paragraph or line) object.
[Android.Runtime.Register("getVisualMap", "()[I", "GetGetVisualMapHandler", ApiSince=29)]
public virtual int[]? GetVisualMap ();
[<Android.Runtime.Register("getVisualMap", "()[I", "GetGetVisualMapHandler", ApiSince=29)>]
abstract member GetVisualMap : unit -> int[]
override this.GetVisualMap : unit -> int[]
Returns
an array of getResultLength()
indexes which will reflect the reordering of the characters.<br><br>
The index map will result in
indexMap[visualIndex]==logicalIndex
, where
indexMap
represents the returned array.
- Attributes
Remarks
Get a visual-to-logical index map (array) for the characters in the Bidi
(paragraph or line) object.
Some values in the map may be MAP_NOWHERE
if the corresponding text characters are Bidi marks inserted in the visual output by the option OPTION_INSERT_MARKS
.
When the visual output is altered by using options of writeReordered()
such as INSERT_LRM_FOR_NUMERIC
, KEEP_BASE_COMBINING
, OUTPUT_REVERSE
, REMOVE_BIDI_CONTROLS
, the logical positions returned may not be correct. It is advised to use, when possible, reordering options such as #OPTION_INSERT_MARKS
and #OPTION_REMOVE_CONTROLS
.
Java documentation for android.icu.text.Bidi.getVisualMap()
.
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.