DocumentBase.ActiveTheme Property

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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 the name of the active theme plus the theme formatting options for the document.

public:
 property System::String ^ ActiveTheme { System::String ^ get(); };

public string ActiveTheme { get; }

member this.ActiveTheme : string

Public ReadOnly Property ActiveTheme As String

Property Value

String

The name of the active theme plus the theme formatting options for the document.

Examples

The following code example applies a theme called Afternoon to the document and then displays a message that shows the name of the active theme. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentActiveTheme()
{
    this.ApplyTheme("AFTRNOON 011");
    MessageBox.Show ("The " + this.ActiveTheme.ToString() + " theme has been"
        + " applied to this document." + "\n" + "The display name is " 
        + this.ActiveThemeDisplayName + ".");
}

Private Sub DocumentActiveTheme()
    Me.ApplyTheme("AFTRNOON 011")
    MessageBox.Show("The " & Me.ActiveTheme.ToString() & " theme has been" _
        & " applied to this document." & vbLf & "The display name is " _
        & Me.ActiveThemeDisplayName & ".")
End Sub

Remarks

This property returns "none" if the document does not have an active theme.

For an explanation of the value returned by this property, see the Name argument of the ApplyTheme method. The value returned by this property might not correspond to the theme's display name. To return a theme's display name, use the ActiveThemeDisplayName property.

Applies to