RichTextBox.SelectionAlignment Property

Gets or sets the alignment to apply to the current selection or insertion point.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public HorizontalAlignment SelectionAlignment { get; set; }
/** @property */
public HorizontalAlignment get_SelectionAlignment ()

/** @property */
public void set_SelectionAlignment (HorizontalAlignment value)

public function get SelectionAlignment () : HorizontalAlignment

public function set SelectionAlignment (value : HorizontalAlignment)

Not applicable.

Property Value

One of the HorizontalAlignment values.

Exception typeCondition

InvalidEnumArgumentException

The specified value is not one of the values defined in the HorizontalAlignment class.

If no paragraph is selected in the control, setting this property applies the alignment setting to the paragraph in which the insertion point appears as well as to paragraphs created after the paragraph that has the alignment property setting. For example, if there are two paragraphs in a RichTextBox control and the insertion point is located within the second paragraph. If you set the SelectionAlignment property to HorizontalAlignment.Center, the paragraph at the insertion point will be centered within the control. If a third paragraph is created after the second paragraph, it also is aligned to the center of the control.

If a selection is made within the control when the property is set, all paragraphs selected are aligned based on this property setting. You can use this property to align the paragraphs in a document being created in the RichTextBox. For example, if you want all paragraphs in a document to be centered, you can select all the paragraphs in the control and set the SelectionAlignment property to HorizontalAlignment.Center.

NoteNote:

SelectionAlignment returns SelectionAlignment.Left when the text selection contains multiple paragraphs with mixed alignment.

The following code example demonstrates how to align text within the RichTextBox. This example requires that a RichTextBox control, named richTextBox1, has been added to the form.

private void WriteCenteredTextToRichTextBox()
{
   // Clear all text from the RichTextBox;
   richTextBox1.Clear();
   // Set the foreground color of the text.
   richTextBox1.ForeColor = Color.Red;
   // Set the alignment of the text that follows.
   richTextBox1.SelectionAlignment = HorizontalAlignment.Center;
   // Set the font for the text.
   richTextBox1.SelectionFont = new Font("Lucinda Console", 12);
   // Set the text within the control.
   richTextBox1.SelectedText = "This text is centered using the SelectionAlignment property.\n";
}

private void WriteCenteredTextToRichTextBox()
{
    // Clear all text from the RichTextBox;
    richTextBox1.Clear();
    // Set the foreground color of the text.
    richTextBox1.set_ForeColor(Color.get_Red());
    // Set the alignment of the text that follows.
    richTextBox1.set_SelectionAlignment(HorizontalAlignment.Center);
    // Set the font for the text.
    richTextBox1.set_SelectionFont(new Font("Lucinda Console", 12));
    // Set the text within the control.
    richTextBox1.set_SelectedText("This text is centered using the"
        + "SelectionAlignment property.\n");
} //WriteCenteredTextToRichTextBox

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: