Skip to main content
Version: 20 R6 BETA

VP SET BORDER

VP SET BORDER ( rangeObj : Object ; borderStyleObj : Object ; borderPosObj : Object )

ParameterTypeDescription
rangeObjObject->Range object
borderStyleObjObject->Object containing border line style
borderPosObjObject->Object containing border placement

Description

The VP SET BORDER command applies the border style(s) defined in borderStyleObj and borderPosObj to the range defined in the rangeObj.

In rangeObj, pass a range of cells where the border style will be applied. If the rangeObj contains multiple cells, borders applied with VP SET BORDER will be applied to the rangeObj as a whole (as opposed to the VP SET CELL STYLE command which applies borders to each cell of the rangeObj). If a style sheet has already been applied, VP SET BORDER will override the previously applied border settings for the rangeObj.

The borderStyleObj parameter allows you to define the style for the lines of the border. The borderStyleObj supports the following properties:

PropertyTypeDescriptionPossible values
colortextDefines the color of the border. Default = black.CSS color "#rrggbb" syntax (preferred syntax), CSS color "rgb(r,g,b)" syntax (alternate syntax), CSS color name (alternate syntax)
styleIntegerDefines the style of the border. Default = empty.
  • vk line style dash dot
  • vk line style dash dot dot
  • vk line style dashed
  • vk line style dotted
  • vk line style double
  • vk line style empty
  • vk line style hair
  • vk line style medium
  • vk line style medium dash dot
  • vk line style medium dash dot dot
  • vk line style medium dashed
  • vk line style slanted dash dot
  • vk line style thick
  • vk line style thin
  • You can define the position of the borderStyleObj (i.e., where the line is applied) with the borderPosObj:

    PropertyTypeDescription
    allbooleanBorder line style applied to all borders.
    leftbooleanBorder line style applied to left border.
    topbooleanBorder line style applied to top border.
    rightbooleanBorder line style applied to right border.
    bottombooleanBorder line style applied to bottom border.
    outlinebooleanBorder line style applied to outer borders only.
    insidebooleanBorder line style applied to inner borders only.
    innerHorizontalbooleanBorder line style applied to inner horizontal borders only.
    innerVerticalbooleanBorder line style applied to inner vertical borders only.

    Example 1

    This code produces a border around the entire range:

    $border:=New object("color";"red";"style";vk line style thick)
    $option:=New object("outline";True)
    VP SET BORDER(VP Cells("ViewProArea";1;1;3;3);$border;$option)

    Example 2

    This code demonstrates the difference between VP SET BORDER and setting borders with the VP SET CELL STYLE command:

    // Set borders using VP SET BORDER
    $border:=New object("color";"red";"style";vk line style thick)
    $option:=New object("outline";True)
    VP SET BORDER(VP Cells("ViewProArea";1;1;3;3);$border;$option)

    // // Set borders using VP SET CELL STYLE
    $cellStyle:=New object
    $cellStyle.borderBottom:=New object("color";"blue";"style";vk line style thick)
    $cellStyle.borderRight:=New object("color";"blue";"style";vk line style thick)
    VP SET CELL STYLE(VP Cells("ViewProArea";4;4;3;3);$cellStyle)

    See also

    VP SET CELL STYLE