XmlMappedRange.BorderAround Method

Article
07/25/2011

Adds a border to an XmlMappedRange control and sets the Color, LineStyle, and Weight properties for the new border.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
Function BorderAround ( _
    LineStyle As Object, _
    Weight As XlBorderWeight, _
    ColorIndex As XlColorIndex, _
    Color As Object _
) As Object

Object BorderAround(
    Object LineStyle,
    XlBorderWeight Weight,
    XlColorIndex ColorIndex,
    Object Color
)

Parameters

LineStyle
Type: System.Object
The line style for the border. Can be one of the following XlLineStyle values:
xlContinuous
xlDash
xlDashDot
xlDashDotDot
xlDot
xlDouble
xlSlantDashDot
xlLineStyleNone

Weight
Type: Microsoft.Office.Interop.Excel.XlBorderWeight
The border weight. Can be one of the following XlBorderWeight constants:
xlHairline
xlMedium
xlThick
xlThin

ColorIndex
Type: Microsoft.Office.Interop.Excel.XlColorIndex
The border color, as an index into the current color palette or as an XlColorIndex constant. Can be one of the following XlColorIndex constants:
xlColorIndexAutomatic
xlColorIndexNone

Color
Type: System.Object
The border color, as an RGB value.

Return Value

Type: System.Object

Remarks

You must specify either ColorIndex or Color, but not both.

You can specify either LineStyle or Weight, but not both. If you do not specify either argument, Microsoft Office Excel uses the default line style and weight.

This method outlines the XmlMappedRange control without filling it in.

To clear the border, you can set the LineStyle property to xlLineStyleNone for the XmlMappedRange control.

Optional Parameters

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

Examples

The following code example uses the BorderAround method to apply a thick border around an XmlMappedRange. The example then prompts the user to clear the border by using the ClearFormats method. This code example assumes that the current worksheet contains an XmlMappedRange named CustomerLastNameCell.

Private Sub SetBorder()
    Me.CustomerLastNameCell.BorderAround( _
        Weight:=Excel.XlBorderWeight.xlThick, _
        ColorIndex:=Excel.XlColorIndex.xlColorIndexAutomatic)

    If MessageBox.Show("Clear the border?", "Test", MessageBoxButtons.YesNo) = _
        DialogResult.Yes Then
        Me.CustomerLastNameCell.ClearFormats()
    End If
End Sub

private void SetBorder()
{
    this.CustomerLastNameCell.BorderAround(missing, 
        Excel.XlBorderWeight.xlThick, 
        Excel.XlColorIndex.xlColorIndexAutomatic, missing);

    if (MessageBox.Show("Clear the border?", "Test",
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        this.CustomerLastNameCell.ClearFormats();
    }
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.