MsoFormatPicture

MsoFormatPicture class

Represents the picture format.

class MsoFormatPicture;

Methods

Method	Description
getTopCropInch()	Represents the location of the top of the crop rectangle expressed, in unit of inches.
setTopCropInch(number)	Represents the location of the top of the crop rectangle expressed, in unit of inches.
getBottomCropInch()	Represents the location of the bottom of the crop rectangle expressed, in unit of inches.
setBottomCropInch(number)	Represents the location of the bottom of the crop rectangle expressed, in unit of inches.
getLeftCropInch()	Represents the location of the left of the crop rectangle expressed, in unit of inches.
setLeftCropInch(number)	Represents the location of the left of the crop rectangle expressed, in unit of inches.
getRightCropInch()	Represents the location of the right of the crop rectangle expressed, in unit of inches.
setRightCropInch(number)	Represents the location of the right of the crop rectangle expressed, in unit of inches.
getTopCrop()	Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.
setTopCrop(number)	Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.
getBottomCrop()	Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.
setBottomCrop(number)	Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.
getLeftCrop()	Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.
setLeftCrop(number)	Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.
getRightCrop()	Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.
setRightCrop(number)	Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.
getTransparency()	Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(number)	Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
getTransparentColor()	Gets and sets the transparent color of the picture.
setTransparentColor(CellsColor)	Gets and sets the transparent color of the picture.
getContrast()	Represents the contrast modification for the picture.in unit of percentage.
setContrast(number)	Represents the contrast modification for the picture.in unit of percentage.
getBrightness()	Represents the brightness modification for the picture in unit of percentage.
setBrightness(number)	Represents the brightness modification for the picture in unit of percentage.
getGamma()	Represents gamma of the picture.
setGamma(number)	Represents gamma of the picture.
isBiLevel()	Indicates whether this picture should display in two-color black and white.
setIsBiLevel(boolean)	Indicates whether this picture should display in two-color black and white.
isGray()	Indicates whether this picture should display in grayscale.
setIsGray(boolean)	Indicates whether this picture should display in grayscale.
getHashCode()	Gets the hash code.
equals(object)
isNull()	Checks whether the implementation object is null.

getTopCropInch()

Represents the location of the top of the crop rectangle expressed, in unit of inches.

getTopCropInch() : number;

setTopCropInch(number)

Represents the location of the top of the crop rectangle expressed, in unit of inches.

setTopCropInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottomCropInch()

Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

getBottomCropInch() : number;

setBottomCropInch(number)

Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

setBottomCropInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftCropInch()

Represents the location of the left of the crop rectangle expressed, in unit of inches.

getLeftCropInch() : number;

setLeftCropInch(number)

Represents the location of the left of the crop rectangle expressed, in unit of inches.

setLeftCropInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRightCropInch()

Represents the location of the right of the crop rectangle expressed, in unit of inches.

getRightCropInch() : number;

setRightCropInch(number)

Represents the location of the right of the crop rectangle expressed, in unit of inches.

setRightCropInch(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTopCrop()

Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.

getTopCrop() : number;

setTopCrop(number)

Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.

setTopCrop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottomCrop()

Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.

getBottomCrop() : number;

setBottomCrop(number)

Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.

setBottomCrop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftCrop()

Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.

getLeftCrop() : number;

setLeftCrop(number)

Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.

setLeftCrop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRightCrop()

Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.

getRightCrop() : number;

setRightCrop(number)

Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.

setRightCrop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTransparency()

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

getTransparency() : number;

setTransparency(number)

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

setTransparency(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTransparentColor()

Gets and sets the transparent color of the picture.

getTransparentColor() : CellsColor;

Returns

CellsColor

setTransparentColor(CellsColor)

Gets and sets the transparent color of the picture.

setTransparentColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getContrast()

Represents the contrast modification for the picture.in unit of percentage.

getContrast() : number;

Remarks

It is between -100% and 100%. It works same as Excel 2007 or above version.

setContrast(number)

Represents the contrast modification for the picture.in unit of percentage.

setContrast(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

It is between -100% and 100%. It works same as Excel 2007 or above version.

getBrightness()

Represents the brightness modification for the picture in unit of percentage.

getBrightness() : number;

Remarks

It is between -100% and 100%. It works same as Excel 2007 or above version.

setBrightness(number)

Represents the brightness modification for the picture in unit of percentage.

setBrightness(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

It is between -100% and 100%. It works same as Excel 2007 or above version.

getGamma()

Represents gamma of the picture.

getGamma() : number;

setGamma(number)

Represents gamma of the picture.

setGamma(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isBiLevel()

Indicates whether this picture should display in two-color black and white.

isBiLevel() : boolean;

setIsBiLevel(boolean)

Indicates whether this picture should display in two-color black and white.

setIsBiLevel(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isGray()

Indicates whether this picture should display in grayscale.

isGray() : boolean;

setIsGray(boolean)

Indicates whether this picture should display in grayscale.

setIsGray(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getHashCode()

Gets the hash code.

getHashCode() : number;

equals(object)

equals(obj: object) : boolean;

Parameters:

Parameter	Type	Description
obj	object

isNull()

Checks whether the implementation object is null.

isNull() : boolean;