Difference between revisions of "Range"

From Xojo Documentation

m
 
Line 8: Line 8:
  
 
<dynamicTable id="Properties" class="propertyTable" title="Properties" columns="3">
 
<dynamicTable id="Properties" class="propertyTable" title="Properties" columns="3">
{{Property | name=EndPos | type=Integer | platform=all | readonly=yes | description=( Integer)&nbsp;&nbsp;The ending position of the StyleRun. }}
+
{{Property | name=EndPosition | type=Integer | platform=all | readonly=yes | description=( Integer)&nbsp;&nbsp;The ending position of the StyleRun. }}
 
{{Property | name=Length | type=Integer | platform=all | description=( Integer)&nbsp;&nbsp;The length of the StyleRun. }}
 
{{Property | name=Length | type=Integer | platform=all | description=( Integer)&nbsp;&nbsp;The length of the StyleRun. }}
{{Property | name=StartPos | type=Integer | platform=all | description=( Integer)&nbsp;&nbsp;The starting position of the StyleRun. The first position is zero. }}
+
{{Property | name=StartPosition | type=Integer | platform=all | description=( Integer)&nbsp;&nbsp;The starting position of the StyleRun. The first position is zero. }}
 
</dynamicTable>
 
</dynamicTable>
  
Line 20: Line 20:
  
 
<rbcode>
 
<rbcode>
Dim count As Integer
+
Var count As Integer
 
count = TextArea1.StyledText.StyleRunCount  // get the number of StyleRuns
 
count = TextArea1.StyledText.StyleRunCount  // get the number of StyleRuns
 
For i As Integer = 0 To count - 1
 
For i As Integer = 0 To count - 1
 
   ListBox1.AddRow(Str(TextArea1.StyledText.StyleRunRange(i).StartPos))
 
   ListBox1.AddRow(Str(TextArea1.StyledText.StyleRunRange(i).StartPos))
   ListBox1.Cell(i, 1) = Str(TextArea1.StyledText.StyleRunRange(i).Length)
+
   ListBox1.CellValueAt(i, 1) = Str(TextArea1.StyledText.StyleRunRange(i).Length)
   ListBox1.Cell(i, 2) = TextArea1.StyledText.StyleRun(i).Text
+
   ListBox1.CellValueAt(i, 2) = TextArea1.StyledText.StyleRun(i).Text
 
Next
 
Next
 
</rbcode>
 
</rbcode>

Latest revision as of 15:14, 24 June 2019

Class (inherits from Object)

Used to get the starting position, length, and end position of a StyleRun.

Properties
EndPosition fa-lock-32.png Length StartPosition

Notes

A StyleRun is a series of characters with the same style attributes in a StyledText object. A block of StyledText can be thought of as a group of StyleRuns that are appended to each other. Use the Range class to access the position of a StyleRun within the styled text.

Examples

The following example loops through the StyleRuns in a block of StyledText that is displayed in a TextArea. It uses the StartPos and Length properties of the Range class to get the position of each StyleRun and displays it and the text of each StyleRun in a ListBox.

Var count As Integer
count = TextArea1.StyledText.StyleRunCount // get the number of StyleRuns
For i As Integer = 0 To count - 1
ListBox1.AddRow(Str(TextArea1.StyledText.StyleRunRange(i).StartPos))
ListBox1.CellValueAt(i, 1) = Str(TextArea1.StyledText.StyleRunRange(i).Length)
ListBox1.CellValueAt(i, 2) = TextArea1.StyledText.StyleRun(i).Text
Next

See Also

Paragraph, StyledText, StyleRun classes; TextArea control.