NamedRange.Characters Property

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.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 a Characters object that represents a range of characters within the text of the NamedRange control.

public:
 property Microsoft::Office::Tools::Excel::NamedRange_CharactersType ^ Characters { Microsoft::Office::Tools::Excel::NamedRange_CharactersType ^ get(); };

public Microsoft.Office.Tools.Excel.NamedRange_CharactersType Characters { get; }

member this.Characters : Microsoft.Office.Tools.Excel.NamedRange_CharactersType

Public ReadOnly Property Characters As NamedRange_CharactersType

Property Value

NamedRange_CharactersType

A Characters object that represents a range of characters within the text of the NamedRange control.

Examples

The following code example creates a NamedRange and populates it with the word Smith. It then changes the first character in the word by making it bold and setting the size to 14.

This version is for a document-level customization.

Microsoft.Office.Tools.Excel.NamedRange charactersRange;
private void FormatCharacters()
{
    charactersRange = this.Controls.AddNamedRange(
        this.Range["A1", "A1"], "charactersRange");
    this.charactersRange.Value2 = "Smith";
    this.charactersRange.Characters[1, 1].Font.Bold = true;
    this.charactersRange.Characters[1, 1].Font.Size = 14;
}

Private charactersRange As Microsoft.Office.Tools.Excel.NamedRange

Private Sub FormatCharacters()
    charactersRange = Me.Controls.AddNamedRange( _
        Me.Range("A1", "A1"), "charactersRange")
    Me.charactersRange.Value2 = "Smith"
    Me.charactersRange.Characters(1, 1).Font.Bold = True
    Me.charactersRange.Characters(1, 1).Font.Size = 14
End Sub

This version is for an application-level add-in.

Remarks

The Characters property is intended to be used with the following parameters.

Parameter	Description
`Start`	The first character to be returned. If this argument is either 1 or omitted, this property returns a range of characters starting with the first character.
`Length`	The number of characters to be returned. If this argument is omitted, this property returns the remainder of the string (everything after the `Start` character).

If you attempt to use Characters without specifying any parameters, Characters will get a NamedRange_CharactersType object that is part of the Visual Studio infrastructure and is not intended to be used directly from your code.

You can use the Microsoft.Office.Interop.Excel.Characters object to format characters within a text string. The Microsoft.Office.Interop.Excel.Characters object is not a collection.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

Share via