OdsPageBackground

OdsPageBackground class

Represents the page background of ods.

class OdsPageBackground;

Constructors

Name	Description
constructor()	Default Constructor.

Methods

Method	Description
getType()	Gets and sets the page background type.
setType(OdsPageBackgroundType)	Gets and sets the page background type.
getColor()	Gets and sets the color of background.
setColor(Color)	Gets and sets the color of background.
getGraphicType()	Gets and sets the page background graphic type.
setGraphicType(OdsPageBackgroundGraphicType)	Gets and sets the page background graphic type.
getGraphicPositionType()	Gets and set the background graphic position.
setGraphicPositionType(OdsPageBackgroundGraphicPositionType)	Gets and set the background graphic position.
isLink()	Indicates whether it’s a linked graphic.
getLinkedGraphic()	Gets and sets the linked graphic path.
setLinkedGraphic(string)	Gets and sets the linked graphic path.
getGraphicData()	Gets and sets the graphic data.
setGraphicData(number[])	Gets and sets the graphic data.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

getType()

Gets and sets the page background type.

getType() : OdsPageBackgroundType;

Returns

OdsPageBackgroundType

setType(OdsPageBackgroundType)

Gets and sets the page background type.

setType(value: OdsPageBackgroundType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundType	The value to set.

getColor()

Gets and sets the color of background.

getColor() : Color;

Returns

Color

setColor(Color)

Gets and sets the color of background.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getGraphicType()

Gets and sets the page background graphic type.

getGraphicType() : OdsPageBackgroundGraphicType;

Returns

OdsPageBackgroundGraphicType

setGraphicType(OdsPageBackgroundGraphicType)

Gets and sets the page background graphic type.

setGraphicType(value: OdsPageBackgroundGraphicType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundGraphicType	The value to set.

getGraphicPositionType()

Gets and set the background graphic position.

getGraphicPositionType() : OdsPageBackgroundGraphicPositionType;

Returns

OdsPageBackgroundGraphicPositionType

setGraphicPositionType(OdsPageBackgroundGraphicPositionType)

Gets and set the background graphic position.

setGraphicPositionType(value: OdsPageBackgroundGraphicPositionType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundGraphicPositionType	The value to set.

isLink()

Indicates whether it’s a linked graphic.

isLink() : boolean;

getLinkedGraphic()

Gets and sets the linked graphic path.

getLinkedGraphic() : string;

setLinkedGraphic(string)

Gets and sets the linked graphic path.

setLinkedGraphic(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getGraphicData()

Gets and sets the graphic data.

getGraphicData() : number[];

Returns

number[]

setGraphicData(number[])

Gets and sets the graphic data.

setGraphicData(value: number[]) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;