OfficeLineFormat Leave feedback
On this page
Inheritance: java.lang.Object
public final class OfficeLineFormat
Represents a shape line format.
| Constructor | Description |
|---|---|
| OfficeLineFormat() | Initializes a new instance of the [OfficeLineFormat](../../com.groupdocs.watermark.contents/officelineformat) class. |
| Method | Description |
|---|---|
| getWeight() | Gets the brush thickness that strokes the path of a shape. |
| setWeight(double value) | Sets the brush thickness that strokes the path of a shape. |
| getColor() | Gets the color of the line. |
| setColor(Color value) | Sets the color of the line. |
| getOpacity() | Gets the line opacity. |
| setOpacity(double value) | Sets the line opacity. |
| getEnabled() | Gets a value indicating whether a shape will be stroked. |
| setEnabled(boolean value) | Sets a value indicating whether a shape will be stroked. |
| getDashStyle() | Gets the dot and dash pattern for a line. |
| setDashStyle(int value) | Sets the dot and dash pattern for a line. |
| getLineStyle() | Gets the line style. |
| setLineStyle(int value) | Sets the line style. |
| getTransparency() | |
| getColorConsideringOpacity() |
public OfficeLineFormat()
Initializes a new instance of the [OfficeLineFormat](../../com.groupdocs.watermark.contents/officelineformat) class.
public final double getWeight()
Gets the brush thickness that strokes the path of a shape.
Returns: double - The line thickness in points. The default value is 0.75.
public final void setWeight(double value)
Sets the brush thickness that strokes the path of a shape.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The line thickness in points. The default value is 0.75. |
public final Color getColor()
Gets the color of the line.
The default value is [Color.getBlack()](../../com.groupdocs.watermark.watermarks/color#getBlack--).
Returns: Color - The color of the line.
public final void setColor(Color value)
Sets the color of the line.
The default value is [Color.getBlack()](../../com.groupdocs.watermark.watermarks/color#getBlack--).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The color of the line. |
public final double getOpacity()
Gets the line opacity.
Returns: double - The value should be between 0 and 1. Default value is 1.
public final void setOpacity(double value)
Sets the line opacity.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The value should be between 0 and 1. Default value is 1. |
public final boolean getEnabled()
Gets a value indicating whether a shape will be stroked.
Returns: boolean - The default value is false.
public final void setEnabled(boolean value)
Sets a value indicating whether a shape will be stroked.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The default value is false. |
public final int getDashStyle()
Gets the dot and dash pattern for a line.
Returns: int
public final void setDashStyle(int value)
Sets the dot and dash pattern for a line.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getLineStyle()
Gets the line style.
The default value is [OfficeLineStyle.Single](../../com.groupdocs.watermark.contents/officelinestyle#Single).
Returns: int - The line style.
public final void setLineStyle(int value)
Sets the line style.
The default value is [OfficeLineStyle.Single](../../com.groupdocs.watermark.contents/officelinestyle#Single).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The line style. |
public final double getTransparency()
Returns: double
public final Color getColorConsideringOpacity()
Returns: Color
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.