MsoFormatPicture

MsoFormatPicture class

Represents the picture format.

class MsoFormatPicture;

Properties

Property	Type	Description
topCropInch	number	Represents the location of the top of the crop rectangle expressed, in unit of inches.
bottomCropInch	number	Represents the location of the bottom of the crop rectangle expressed, in unit of inches.
leftCropInch	number	Represents the location of the left of the crop rectangle expressed, in unit of inches.
rightCropInch	number	Represents the location of the right of the crop rectangle expressed, in unit of inches.
topCrop	number	Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.
bottomCrop	number	Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.
leftCrop	number	Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.
rightCrop	number	Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.
transparency	number	Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
transparentColor	CellsColor	Gets and sets the transparent color of the picture.
contrast	number	Represents the contrast modification for the picture.in unit of percentage.
brightness	number	Represents the brightness modification for the picture in unit of percentage.
gamma	number	Represents gamma of the picture.
isBiLevel	boolean	Indicates whether this picture should display in two-color black and white.
isGray	boolean	Indicates whether this picture should display in grayscale.

Methods

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

topCropInch

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

topCropInch : number;

bottomCropInch

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

bottomCropInch : number;

leftCropInch

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

leftCropInch : number;

rightCropInch

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

rightCropInch : number;

topCrop

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

topCrop : number;

bottomCrop

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

bottomCrop : number;

leftCrop

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

leftCrop : number;

rightCrop

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

rightCrop : number;

transparency

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

transparency : number;

transparentColor

Gets and sets the transparent color of the picture.

transparentColor : CellsColor;

contrast

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

contrast : number;

Remarks

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

brightness

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

brightness : number;

Remarks

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

gamma

Represents gamma of the picture.

gamma : number;

isBiLevel

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

isBiLevel : boolean;

isGray

Indicates whether this picture should display in grayscale.

isGray : boolean;

getTopCropInch()

@deprecated. Please use the ’topCropInch’ property instead. Represents the location of the top of the crop rectangle expressed, in unit of inches.

getTopCropInch() : number;

setTopCropInch(number)

@deprecated. Please use the ’topCropInch’ property instead. 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()

@deprecated. Please use the ‘bottomCropInch’ property instead. Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

getBottomCropInch() : number;

setBottomCropInch(number)

@deprecated. Please use the ‘bottomCropInch’ property instead. 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()

@deprecated. Please use the ’leftCropInch’ property instead. Represents the location of the left of the crop rectangle expressed, in unit of inches.

getLeftCropInch() : number;

setLeftCropInch(number)

@deprecated. Please use the ’leftCropInch’ property instead. 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()

@deprecated. Please use the ‘rightCropInch’ property instead. Represents the location of the right of the crop rectangle expressed, in unit of inches.

getRightCropInch() : number;

setRightCropInch(number)

@deprecated. Please use the ‘rightCropInch’ property instead. 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()

@deprecated. Please use the ’topCrop’ property instead. Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image’s height.

getTopCrop() : number;

setTopCrop(number)

@deprecated. Please use the ’topCrop’ property instead. 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()

@deprecated. Please use the ‘bottomCrop’ property instead. Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image’s height.

getBottomCrop() : number;

setBottomCrop(number)

@deprecated. Please use the ‘bottomCrop’ property instead. 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()

@deprecated. Please use the ’leftCrop’ property instead. Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image’s width.

getLeftCrop() : number;

setLeftCrop(number)

@deprecated. Please use the ’leftCrop’ property instead. 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()

@deprecated. Please use the ‘rightCrop’ property instead. Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image’s width.

getRightCrop() : number;

setRightCrop(number)

@deprecated. Please use the ‘rightCrop’ property instead. 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()

@deprecated. Please use the ’transparency’ property instead. 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)

@deprecated. Please use the ’transparency’ property instead. 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()

@deprecated. Please use the ’transparentColor’ property instead. Gets and sets the transparent color of the picture.

getTransparentColor() : CellsColor;

Returns

CellsColor

setTransparentColor(CellsColor)

@deprecated. Please use the ’transparentColor’ property instead. Gets and sets the transparent color of the picture.

setTransparentColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getContrast()

@deprecated. Please use the ‘contrast’ property instead. 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)

@deprecated. Please use the ‘contrast’ property instead. 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()

@deprecated. Please use the ‘brightness’ property instead. 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)

@deprecated. Please use the ‘brightness’ property instead. 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()

@deprecated. Please use the ‘gamma’ property instead. Represents gamma of the picture.

getGamma() : number;

setGamma(number)

@deprecated. Please use the ‘gamma’ property instead. Represents gamma of the picture.

setGamma(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isBiLevel()

@deprecated. Please use the ‘isBiLevel’ property instead. Indicates whether this picture should display in two-color black and white.

isBiLevel() : boolean;

setIsBiLevel(boolean)

@deprecated. Please use the ‘isBiLevel’ property instead. 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()

@deprecated. Please use the ‘isGray’ property instead. Indicates whether this picture should display in grayscale.

isGray() : boolean;

setIsGray(boolean)

@deprecated. Please use the ‘isGray’ property instead. Indicates whether this picture should display in grayscale.

setIsGray(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getHashCode()

Gets the hash code.

getHashCode() : number;

equals(Object)

equals(obj: Object) : boolean;

Parameters:

Parameter	Type	Description
obj	Object