StringTrimming Enum

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v9.0.0-rc.2.24474.1

Source:

StringTrimming.cs

Specifies how to trim characters from a string that does not completely fit into a layout shape.

public enum class StringTrimming

public enum StringTrimming

type StringTrimming = 

Public Enum StringTrimming

Inheritance

Object

ValueType

Enum

StringTrimming

Fields

Name	Value	Description
None	0	Specifies no trimming.
Character	1	Specifies that the text is trimmed to the nearest character.
Word	2	Specifies that text is trimmed to the nearest word.
EllipsisCharacter	3	Specifies that the text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line.
EllipsisWord	4	Specifies that text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line.
EllipsisPath	5	The center is removed from trimmed lines and replaced by an ellipsis. The algorithm keeps as much of the last slash-delimited segment of the line as possible.

Examples

The following example shows how to set the Trimming property and how to use the StringTrimming enumeration. This example is designed to be used with a Windows Form. Paste this code into a form and call the ShowStringTrimming method when handling the form's Paint event, passing e as PaintEventArgs.

private:
   void ShowStringTrimming( PaintEventArgs^ e )
   {
      StringFormat^ format1 = gcnew StringFormat;
      String^ quote = "Not everything that can be counted counts,"
      " and not everything that counts can be counted.";
      format1->Trimming = StringTrimming::EllipsisWord;
      e->Graphics->DrawString( quote, this->Font, Brushes::Black, RectangleF(10.0F,10.0F,90.0F,50.0F), format1 );
   }

private void ShowStringTrimming(PaintEventArgs e)
{

    StringFormat format1 = new StringFormat();
    string quote = "Not everything that can be counted counts," +
        " and not everything that counts can be counted.";
    format1.Trimming = StringTrimming.EllipsisWord;
    e.Graphics.DrawString(quote, this.Font, Brushes.Black, 
        new RectangleF(10.0F, 10.0F, 90.0F, 50.0F), format1);
}

Private Sub ShowStringTrimming(ByVal e As PaintEventArgs)

    Dim format1 As New StringFormat
    Dim quote As String = "Not everything that can be counted counts," & _
        " and not everything that counts can be counted."
    format1.Trimming = StringTrimming.EllipsisWord
    e.Graphics.DrawString(quote, Me.Font, Brushes.Black, _
        New RectangleF(10.0F, 10.0F, 90.0F, 50.0F), format1)
End Sub