Method Details

• getPatternColor

  IColorFormat getPatternColor()

  Returns the IColorFormat object that represents the specified color of patterns.

  Use this method to access and modify the color applied to a patterned line, typically after calling patterned(PatternType) to set the line to a pattern fill.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.patterned(PatternType.Percent10);
   IColorFormat patternColor = line.getPatternColor();
   patternColor.setRGB(Color.GetRed());
   

  Returns:

  The IColorFormat object that represents the pattern color of the line.

• getColor

  IColorFormat getColor()

  Gets the IColorFormat object that represents the specified solid color.

  Use this method to access or modify the solid color settings of the line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   IColorFormat color = line.getColor();
   color.setRGB(Color.GetRed());
   

  Returns:

  The IColorFormat object that represents the solid color of the line.

• getType

  FillType getType()

  Returns the fill type of the line.

  Use this method to determine whether the line is currently configured with a solid, patterned, or gradient fill.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.patterned(PatternType.Percent10);
   FillType type = line.getType();
   

  Returns:

  The FillType that indicates the current fill type of the line.

• getBeginArrowheadLength

  ArrowheadLength getBeginArrowheadLength()

  Gets the length of the arrowhead at the beginning of the specified line.

  Use this method to retrieve the current ArrowheadLength setting for the line's beginning arrowhead.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   line.setBeginArrowheadLength(ArrowheadLength.Long);
   ArrowheadLength length = line.getBeginArrowheadLength();
   

  Returns:

  The ArrowheadLength of the arrowhead at the beginning of the specified line.

• setBeginArrowheadLength

  void setBeginArrowheadLength(ArrowheadLength value)

  Sets the length of the arrowhead at the beginning of the specified line.

  Use this method to control the size of the arrowhead applied to the start of a shape or connector line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   line.setBeginArrowheadLength(ArrowheadLength.Long);
   

  Parameters:

  value - The ArrowheadLength to apply to the arrowhead at the beginning of the line.

• getBeginArrowheadStyle

  ArrowheadStyle getBeginArrowheadStyle()

  Gets the style of the arrowhead at the beginning of the specified line.

  Use this method to retrieve the current ArrowheadStyle applied to the beginning of a connector or shape line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   ArrowheadStyle style = line.getBeginArrowheadStyle();
   

  Returns:

  The ArrowheadStyle of the arrowhead at the beginning of the specified line.

• setBeginArrowheadStyle

  void setBeginArrowheadStyle(ArrowheadStyle value)

  Sets the style of the arrowhead at the beginning of the specified line.

  Use this method to configure the ArrowheadStyle applied to the beginning of a connector or shape line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   

  Parameters:

  value - The ArrowheadStyle to apply to the arrowhead at the beginning of the specified line.

• getBeginArrowheadWidth

  ArrowheadWidth getBeginArrowheadWidth()

  Gets the width of the arrowhead at the beginning of the specified line.

  Use this method to retrieve the current ArrowheadWidth setting for the line's beginning arrowhead.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   line.setBeginArrowheadWidth(ArrowheadWidth.Wide);
   ArrowheadWidth width = line.getBeginArrowheadWidth();
   

  Returns:

  The ArrowheadWidth of the arrowhead at the beginning of the specified line.

• setBeginArrowheadWidth

  void setBeginArrowheadWidth(ArrowheadWidth value)

  Sets the width of the arrowhead at the beginning of the specified line.

  Use ArrowheadWidth constants to control how narrow or wide the starting arrowhead appears.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setBeginArrowheadStyle(ArrowheadStyle.Triangle);
   line.setBeginArrowheadWidth(ArrowheadWidth.Wide);
   

  Parameters:

  value - The arrowhead width to apply at the beginning of the line.

• getDashStyle

  LineDashStyle getDashStyle()

  Gets the dash style for the specified line. Can be one of the LineDashStyle constants.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setDashStyle(LineDashStyle.Dash);
   LineDashStyle dashStyle = line.getDashStyle();
   

  Returns:

  The dash style for the specified line.

• setDashStyle

  void setDashStyle(LineDashStyle value)

  Sets the dash style for the specified line. Can be one of the LineDashStyle constants.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setDashStyle(LineDashStyle.Dash);
   

  Parameters:

  value - The dash style to apply to the line.

• getCapStyle

  LineCapStyle getCapStyle()

  Gets the cap style for the end of the line. Can be one of the LineCapStyle constants.

  Use setCapStyle(LineCapStyle) to change the cap style.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setCapStyle(LineCapStyle.Round);
   LineCapStyle style = line.getCapStyle();
   

  Returns:

  The cap style for the end of the line.

• setCapStyle

  void setCapStyle(LineCapStyle value)

  Sets the cap style for the end of the line. Can be one of the LineCapStyle constants.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setCapStyle(LineCapStyle.Round);
   

  Parameters:

  value - The cap style for the end of the line.

• getJoinStyle

  LineJoinStyle getJoinStyle()

  Gets the corners style of two intersecting lines. Can be one of the LineJoinStyle constants.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setJoinStyle(LineJoinStyle.Round);
   LineJoinStyle style = line.getJoinStyle();
   

  Returns:

  The corners style of two intersecting lines.

• setJoinStyle

  void setJoinStyle(LineJoinStyle value)

  Sets the corners style of two intersecting lines. Can be one of the LineJoinStyle constants.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setJoinStyle(LineJoinStyle.Round);
   

  Parameters:

  value - The join style to apply. Can be one of the LineJoinStyle constants.

• getEndArrowheadLength

  ArrowheadLength getEndArrowheadLength()

  Gets the length of the arrowhead at the end of the specified line.

  Use this method to retrieve the current ArrowheadLength setting for the line's ending arrowhead.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Triangle);
   line.setEndArrowheadLength(ArrowheadLength.Long);
   ArrowheadLength length = line.getEndArrowheadLength();
   

  Returns:

  The ArrowheadLength of the arrowhead at the end of the specified line.

• setEndArrowheadLength

  void setEndArrowheadLength(ArrowheadLength value)

  Sets the length of the arrowhead at the end of the specified line.

  Use this method with setEndArrowheadStyle(ArrowheadStyle) to configure the appearance of the arrowhead at the end of a line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Triangle);
   line.setEndArrowheadLength(ArrowheadLength.Long);
   

  Parameters:

  value - The arrowhead length to apply to the end of the line.

• getEndArrowheadStyle

  ArrowheadStyle getEndArrowheadStyle()

  Gets the style of the arrowhead at the end of the specified line.

  Use this method to retrieve the current ArrowheadStyle applied to the end of a connector or shape line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Triangle);
   ArrowheadStyle style = line.getEndArrowheadStyle();
   

  Returns:

  The ArrowheadStyle of the arrowhead at the end of the specified line.

• setEndArrowheadStyle

  void setEndArrowheadStyle(ArrowheadStyle value)

  Sets the style of the arrowhead at the end of the specified line.

  Use this method to configure the ArrowheadStyle applied to the end of a connector or shape line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Open);
   

  Parameters:

  value - The ArrowheadStyle to apply to the arrowhead at the end of the specified line.

• getEndArrowheadWidth

  ArrowheadWidth getEndArrowheadWidth()

  Gets the width of the arrowhead at the end of the specified line.

  Use this method to read the current end arrowhead width configured for the line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Triangle);
   line.setEndArrowheadWidth(ArrowheadWidth.Wide);
   ArrowheadWidth width = line.getEndArrowheadWidth();
   

  Returns:

  The ArrowheadWidth of the arrowhead at the end of the specified line.

• setEndArrowheadWidth

  void setEndArrowheadWidth(ArrowheadWidth value)

  Sets the width of the arrowhead at the end of the specified line.

  Use ArrowheadWidth constants to control how narrow or wide the ending arrowhead appears.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setEndArrowheadStyle(ArrowheadStyle.Triangle);
   line.setEndArrowheadWidth(ArrowheadWidth.Wide);
   

  Parameters:

  value - The arrowhead width to apply at the end of the line.

• getInsetPen

  boolean getInsetPen()

  Gets whether lines are drawn inside the specified shape's boundaries.

  This property indicates whether the line is rendered within the shape outline instead of being centered on the shape boundary.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setInsetPen(true);
   boolean insetPen = line.getInsetPen();
   

  Returns:

  true if lines are drawn inside the specified shape's boundaries; otherwise, false.

• setInsetPen

  void setInsetPen(boolean value)

  Sets whether lines are drawn inside the specified shape's boundaries.

  This property indicates whether the line is rendered within the shape outline instead of being centered on the shape boundary.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setInsetPen(true);
   

  Parameters:

  value - true if lines are drawn inside the specified shape's boundaries; otherwise, false.

• getPattern

  PatternType getPattern()

  Gets the line pattern.

  Use this method to retrieve the current PatternType applied to the line after the line has been configured with a pattern fill.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.patterned(PatternType.Cross);
   PatternType pattern = line.getPattern();
   

  Returns:

  The current line pattern.

• getStyle

  LineStyle getStyle()

  Gets the LineStyle object that represents the ILineFormat style.

  Use this method to retrieve the current compound line style applied to a shape line, such as LineStyle.Single or LineStyle.ThickBetweenThin.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setStyle(LineStyle.Single);
   LineStyle style = line.getStyle();
   

  Returns:

  The LineStyle object that represents the current ILineFormat style.

• setStyle

  void setStyle(LineStyle value)

  Sets the LineStyle object that represents the ILineFormat style.

  Use this method to apply a predefined line style, such as LineStyle.Single, LineStyle.ThinThin, or LineStyle.ThickBetweenThin, to a shape line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setStyle(LineStyle.Single);
   

  Parameters:

  value - The LineStyle to apply to the line.

• getTransparency

  double getTransparency()

  Gets the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setTransparency(0.25);
   double transparency = line.getTransparency();
   

  Returns:

  The degree of transparency of the line, from 0.0 for a fully opaque line to 1.0 for a fully clear line.

• setTransparency

  void setTransparency(double value)

  Sets the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setTransparency(0.25);
   

  Parameters:

  value - The degree of transparency of the line, from 0.0 for a fully opaque line to 1.0 for a fully clear line.

• getVisible

  boolean getVisible()

  Gets whether the object is visible.

  Use this method to check whether the line for the shape is currently displayed.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setVisible(false);
   boolean visible = line.getVisible();
   

  Returns:

  true if the object is visible; otherwise, false.

• setVisible

  void setVisible(boolean value)

  Sets whether the object is visible.

  Use this method to set whether the line for the shape is currently displayed.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setVisible(false);
   

  Parameters:

  value - true if the object is visible; otherwise, false.

• getGradientAngle

  double getGradientAngle()

  Gets the angle of the gradient line for the specified line format.

  Use this property to get the current direction of a gradient that has been applied to the line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.twoColorGradient(GradientStyle.Horizontal, 1);
   line.setGradientAngle(45);
   double angle = line.getGradientAngle();
   

  Returns:

  The angle of the gradient line for the specified line format.

• setGradientAngle

  void setGradientAngle(double value)

  Sets the angle of the gradient line for the specified line format.

  Use this property to set the direction of a gradient that has been applied to the line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.twoColorGradient(GradientStyle.Horizontal, 1);
   line.setGradientAngle(45);
   

  Parameters:

  value - The angle of the gradient line for the specified line format.

• getGradientDegree

  double getGradientDegree()

  Returns the gradient degree of the specified one-color shaded line as a floating-point value from 0.0 (dark) through 1.0 (light).

  Use this property to retrieve the shading intensity that was applied by oneColorGradient(GradientStyle,int,double).

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.oneColorGradient(GradientStyle.DiagonalDown, 2, 0.5);
   double degree = line.getGradientDegree();
   

  Returns:

  The gradient degree for the one-color shaded line, from 0.0 (dark)through 1.0 (light).

• getGradientStops

  IGradientStops getGradientStops()

  Returns the end point for the gradient line. This property is read-only.

  Use the returned IGradientStops collection to access the gradient stops defined for the line after applying a gradient style.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.twoColorGradient(GradientStyle.Horizontal, 1);
   IGradientStops gradientStops = line.getGradientStops();
   IGradientStop firstStop = gradientStops.get(0);
   

  Returns:

  The IGradientStops collection for the line gradient.

• getGradientStyle

  GradientStyle getGradientStyle()

  Returns the gradient style for the specified line.

  Use this method to determine how the current gradient is applied to the line, such as horizontal, vertical, or diagonal shading.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.oneColorGradient(GradientStyle.Vertical, 1, 0.5);
   GradientStyle style = line.getGradientStyle();
   

  Returns:

  The gradient style for the specified line.

• getGradientVariant

  int getGradientVariant()

  Returns the shade variant for the specified fill as an integer value from 1 through 4.

  This property indicates which gradient variant is applied to the line when a gradient fill is used.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.oneColorGradient(GradientStyle.Horizontal, 2, 0.5);
   int variant = line.getGradientVariant();
   

  Returns:

  The gradient shade variant as an integer from 1 through 4.

• getWeight

  double getWeight()

  Gets the weight of the line.

  This value represents the thickness applied to the line formatting of the shape.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setWeight(2.25);
   double weight = line.getWeight();
   

  Returns:

  The weight of the line.

• setWeight

  void setWeight(double value)

  Sets the weight of the line.

  This value represents the thickness applied to the line formatting of the shape.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.setWeight(2.25);
   

  Parameters:

  value - The weight of the line.

• oneColorGradient

  void oneColorGradient(GradientStyle style, int variant, double degree)

  Sets the specified line to a one-color gradient.

  Use degree to control the gradient intensity from dark to light.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.oneColorGradient(GradientStyle.Horizontal, 2, 0.5);
   

  Parameters:

  style - Required GradientStyle. Can be one of the following GradientStyle constants: GradientDiagonalDown, GradientDiagonalUp, GradientFromCenter, GradientFromCorner, GradientFromTitle, Horizontal, or Vertical.

  variant - Required Integer. The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the line Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.

  degree - Required Single. The gradient degree. Can be a value from 0.0(dark) through 1.0 (light).

• twoColorGradient

  void twoColorGradient(GradientStyle style, int variant)

  Sets the specified line to a two-color gradient.

  Use the style and variant parameters to choose one of the built-in two-color gradient patterns for the line. The supported styles are GradientStyle.DiagonalDown, GradientStyle.DiagonalUp, GradientStyle.FromCenter, GradientStyle.FromCorner, GradientStyle.FromTitle, GradientStyle.Horizontal, and GradientStyle.Vertical.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.twoColorGradient(GradientStyle.Horizontal, 1);
   

  Parameters:

  style - Required GradientStyle. Can be one of the following GradientStyle constants: GradientDiagonalDown, GradientDiagonalUp, GradientFromCenter, GradientFromCorner, GradientFromTitle, Horizontal, or Vertical.

  variant - Required Integer. The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the line Effects dialog box. If style is GradientStyle.FromCenter, variant can only be 1 or 2.

• presetGradient

  void presetGradient(GradientStyle style, int variant, PresetGradientType presetGradientType)

  Sets the specified line to a preset gradient.

  Use this method to apply one of the predefined gradient combinations to the line. The gradient style controls the direction of the gradient, and the variant selects one of the available preset layouts for that style.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.presetGradient(GradientStyle.Vertical, 4, PresetGradientType.CalmWater);
   

  Parameters:

  style - The required GradientStyle. Can be GradientStyle.DiagonalDown, GradientStyle.DiagonalUp, GradientStyle.FromCenter, GradientStyle.FromCorner, GradientStyle.FromTitle, GradientStyle.Horizontal, or GradientStyle.Vertical.

  variant - The required gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the line Effects dialog box. If style is GradientStyle.FromCenter, this argument can only be 1 or 2.

  presetGradientType - The required PresetGradientType that specifies the predefined gradient to apply.

• solid

  void solid()

  Sets the specified line to a uniform color.

  After calling this method, use getColor() to configure the solid color of the line.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.solid();
   line.getColor().setRGB(Color.GetRed());
   

• patterned

  void patterned(PatternType pattern)

  Sets the specified line to a pattern color.

  Use this method to apply a patterned fill to the line by specifying a PatternType.

  
   IShape connector = worksheet.getShapes().addConnector(ConnectorType.Straight, 10, 10, 200, 100);
   ILineFormat line = connector.getLine();
   line.patterned(PatternType.Percent10);
   

  Parameters:

  pattern - The pattern type to apply to the line. Must not be null.