Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ToolStripItemTextRenderEventArgs Class

Provides data for the RenderItemText event.

System.Object
  System.EventArgs
    System.Windows.Forms.ToolStripItemRenderEventArgs
      System.Windows.Forms.ToolStripItemTextRenderEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public class ToolStripItemTextRenderEventArgs : ToolStripItemRenderEventArgs

The ToolStripItemTextRenderEventArgs type exposes the following members.

  NameDescription
Public methodToolStripItemTextRenderEventArgs(Graphics, ToolStripItem, String, Rectangle, Color, Font, ContentAlignment)Initializes a new instance of the ToolStripItemTextRenderEventArgs class with the specified text and text properties.
Public methodToolStripItemTextRenderEventArgs(Graphics, ToolStripItem, String, Rectangle, Color, Font, TextFormatFlags)Initializes a new instance of the ToolStripItemTextRenderEventArgs class with the specified text and text properties format.
Top

  NameDescription
Public propertyGraphicsGets the graphics used to paint the ToolStripItem. (Inherited from ToolStripItemRenderEventArgs.)
Public propertyItemGets the ToolStripItem to paint. (Inherited from ToolStripItemRenderEventArgs.)
Public propertyTextGets or sets the text to be drawn on the ToolStripItem.
Public propertyTextColorGets or sets the color of the ToolStripItem text.
Public propertyTextDirectionGets or sets whether the text is drawn vertically or horizontally.
Public propertyTextFontGets or sets the font of the text drawn on the ToolStripItem.
Public propertyTextFormatGets or sets the display and layout information of the text drawn on the ToolStripItem.
Public propertyTextRectangleGets or sets the rectangle that represents the bounds to draw the text in.
Public propertyToolStripGets the value of the ToolStripItem.Owner property for the ToolStripItem to paint. (Inherited from ToolStripItemRenderEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the RenderItemText event. This report helps you to learn when the event occurs and can assist you in debugging.

To run the example code, paste it into a project that contains an instance of a type that inherits from ToolStripRenderer, such as a ToolStripSystemRenderer or ToolStripProfessionalRenderer. Then name the instance ToolStripRenderer1 and ensure that the event handler is associated with the RenderItemText event.

private void ToolStripRenderer1_RenderItemText(Object sender, ToolStripItemTextRenderEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "Text", e.Text );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TextColor", e.TextColor );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TextFont", e.TextFont );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TextRectangle", e.TextRectangle );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TextFormat", e.TextFormat );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TextDirection", e.TextDirection );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Graphics", e.Graphics );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Item", e.Item );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ToolStrip", e.ToolStrip );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "RenderItemText Event" );
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft