TextFormattingRunProperties.SetBackgroundBrush(Brush) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Formatting

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:: Microsoft.VisualStudio.Text.UI.Wpf v17.9.187

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a new TextFormattingRunProperties with the properties of this one but with the background brush set to brush.

public:
 Microsoft::VisualStudio::Text::Formatting::TextFormattingRunProperties ^ SetBackgroundBrush(System::Windows::Media::Brush ^ brush);

public Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties SetBackgroundBrush (System.Windows.Media.Brush brush);

member this.SetBackgroundBrush : System.Windows.Media.Brush -> Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties

Public Function SetBackgroundBrush (brush As Brush) As TextFormattingRunProperties

Parameters

brush: Brush

The new background brush.

Returns

TextFormattingRunProperties

The TextFormattingRunProperties.

Exceptions

ArgumentNullException

brush is null.

Remarks

The brush is frozen by this method.

Applies to