Paragraph

From Xojo Documentation
Jump to: navigation, search

Class (inherits from Object)

A paragraph of StyledText.

Properties
Alignment Length
EndPos ReadOnlyProperty.png StartPos

Class Constants

The following class constants can be used to set the value of the Alignment property.

Class Constant Description
AlignDefault Default paragraph alignment.
AlignLeft Left alignment.
AlignCenter Center alignment.
AlignRight Right alignment.

Notes

Use the Paragraph class to refer to a paragraph of text within a block of StyledText. A paragraph is defined as all the text between two paragraph separators. A separator can be the EndOfLine function or the correct separator character for the platform on which the application is running. Completely empty paragraphs (e.g., blank lines) do not count as paragraphs.

You use the ParagraphCount method of the StyledText class to get the number of paragraphs in the StyledText object and the Paragraph method of the StyledText class to refer to a particular paragraph.

The Paragraph has one style attribute, Alignment. It gets the current alignment for the paragraph. The alignment is set by calling the ParagraphAlignment method of the StyledText class.

Examples

The following example sets a paragraph's alignment to Centered. It then gets the starting position and length of the paragraph via the Paragraph class and applies several style attributes to the whole paragraph. The TextArea that displays the styled text must have the MultiLine and Styled properties set to True.

Dim Text As String
Dim st, ln As Integer

// define four paragraphs in Text
Text = "This is the text that we are going to save " _
+ "into our file from the TextArea." + EndOfLine _
+ "Isn't that interesting?" + EndOfLine _
+ "Man, I sure do love using Xojo to take care of my projects." + EndOfLine _
+ "That's because the Xojo staff is just so awesome!"
TextArea1.StyledText.Text = text // four paragraphs in Text

// center the second paragraph
TextArea1.StyledText.ParagraphAlignment(1) = Paragraph.AlignCenter

// set the second paragraph in Helvetica, 18 pt bold, red
// first get its character positions...
st = TextArea1.StyledText.Paragraph(1).StartPos
ln = TextArea1.StyledText.Paragraph(1).Length

// next apply attributes...
TextArea1.StyledText.Bold(st, ln) = True
TextArea1.StyledText.Font(st, ln) = "Helvetica"
TextArea1.StyledText.Size(st, ln) = 18
TextArea1.StyledText.TextColor(st, ln) = &cFF0000 // red

See Also

TextArea, Range, StyledText, StyleRun classes.

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About