NamedRange.NumberFormat Property

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.dll

Gets or sets the format code for the NamedRange control.

public:
 property System::Object ^ NumberFormat { System::Object ^ get(); void set(System::Object ^ value); };

public object NumberFormat { get; set; }

member this.NumberFormat : obj with get, set

Public Property NumberFormat As Object

Property Value

Object

The format code for the NamedRange control.

Examples

The following code example uses the NumberFormat property to format a date string in a NamedRange. The example also uses the NumberFormatLocal property to display the date format in the language of the user.

This example is for a document-level customization.

Microsoft.Office.Tools.Excel.NamedRange formatRange;
private void ApplyNumberFormatting()
{
    formatRange = this.Controls.AddNamedRange(
         this.Range["C1"], "formatRange");

    this.formatRange.Value2 = "4-Apr-1974";
    this.formatRange.NumberFormat = "m/d/yyyy";

    // Display the number format in the language of the user.
    MessageBox.Show("The number format for the NamedRange is: " +
        this.formatRange.NumberFormatLocal.ToString());
}

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

Private Sub ApplyNumberFormatting()
    formatRange = Me.Controls.AddNamedRange( _
        Me.Range("C1"), "formatRange")

    Me.formatRange.Value2 = "4-Apr-1974"
    Me.formatRange.NumberFormat = "m/d/yyyy"

    ' Display the number format in the language of the user.
    MessageBox.Show("The number format for the NamedRange is: " & _
        Me.formatRange.NumberFormatLocal.ToString())
End Sub

Remarks

This property returns null if all cells in the NamedRange control do not have the same number format.

The format code is the same string as the Format Codes option in the Format Cells dialog box. The Format function uses different format code strings than do the NumberFormat and NumberFormatLocal properties.