DrawListViewSubItemEventArgs.DrawText Method (TextFormatFlags)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Draws the text of the ListViewItem.ListViewSubItem using its current foreground color and formatting it with the specified TextFormatFlags values.

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

Public Sub DrawText (
	flags As TextFormatFlags
)

Parameters

flags
Type: System.Windows.Forms.TextFormatFlags

A bitwise combination of TextFormatFlags values.

Use this method to draw the subitem text using the current values of the ListViewItem.ListViewSubItem.ForeColor and ListViewItem.ListViewSubItem.Font properties. The text is drawn within the area specified by the Bounds property. The TextFormatFlags values specified in the flags parameter let you provide formatting properties for the node label, such as text alignment.

System_CAPS_noteNote

The UseItemStyleForSubItems property of the parent ListViewItem must be set to false to prevent the ListViewItem.ForeColor and ListViewItem.Font values of the parent item from overriding the subitem values.

The following code example demonstrates how to use the DrawText method in an application that provides custom drawing for a ListView control. In the example, a handler for the ListView.DrawSubItem event draws the subitem text values and both the text and background for subitems that have negative values.

For the complete example, see the DrawListViewSubItemEventArgs overview reference topic.

' Draws subitem text and applies content-based formatting.
Private Sub listView1_DrawSubItem(ByVal sender As Object, _
    ByVal e As DrawListViewSubItemEventArgs) _
    Handles listView1.DrawSubItem

    Dim flags As TextFormatFlags = TextFormatFlags.Left

    Dim sf As New StringFormat()
    Try

        ' Store the column text alignment, letting it default
        ' to Left if it has not been set to Center or Right.
        Select Case e.Header.TextAlign
            Case HorizontalAlignment.Center
                sf.Alignment = StringAlignment.Center
                flags = TextFormatFlags.HorizontalCenter
            Case HorizontalAlignment.Right
                sf.Alignment = StringAlignment.Far
                flags = TextFormatFlags.Right
        End Select

        ' Draw the text and background for a subitem with a 
        ' negative value. 
        Dim subItemValue As Double
        If e.ColumnIndex > 0 AndAlso _
            Double.TryParse(e.SubItem.Text, NumberStyles.Currency, _
            NumberFormatInfo.CurrentInfo, subItemValue) AndAlso _
            subItemValue < 0 Then

            ' Unless the item is selected, draw the standard 
            ' background to make it stand out from the gradient.
            If (e.ItemState And ListViewItemStates.Selected) = 0 Then
                e.DrawBackground()
            End If

            ' Draw the subitem text in red to highlight it. 
            e.Graphics.DrawString(e.SubItem.Text, _
                Me.listView1.Font, Brushes.Red, e.Bounds, sf)

            Return

        End If

        ' Draw normal text for a subitem with a nonnegative 
        ' or nonnumerical value.
        e.DrawText(flags)

    Finally
        sf.Dispose()
    End Try

End Sub

.NET Framework
Available since 2.0
Return to top
Show: