ImageData Class

Represents the image data of a picture.

Inheritance

object

FormattingBag

EmbeddedImageData

ImageData

Namespace: GrapeCity.Documents.Word

Assembly: DS.Documents.Word.dll

Syntax

public class ImageData : EmbeddedImageData

Public Class ImageData
    Inherits EmbeddedImageData

Properties

Name	Description
Brightness	Gets or sets a value to change the brightness. Allowed values are from -1 (darkest) to 1 (lightest), inclusive. The default is 0.
ComplementaryVectorData	Gets the complementary vector data of the image.
Compression	Gets or sets the image compression value.
Contrast	Gets or sets a value to change the contrast. Allowed values are from -1 to 1, inclusive. The default is 0.
Crop	Gets the portion of the image used for the fill.
Dpi	Gets or sets the DPI (dots per inch) used to calculate the size of the image. If zero, the DPI in the image is used.
Effects	Gets the list of the image effects.
FillType	Gets or sets the image fill type.
HasImage	Gets a value indicating whether the picture contains image bytes or links to an image.
IsLink	Gets a value indicating whether the image is linked to this picture (when Source is specified).
IsLinkOnly	Gets a value indicating whether the image is linked and not stored in the document.
RotateWithObject	Gets or sets whether the data rotates along with the object when the object is rotated.
Saturation	Gets the amount of saturation applied to the picture.
Sharpness	Gets the amount to sharpen (if positive) or the amount to blur (if negative).
Source	Gets or sets the path and name of the source file for the linked image.
Stretch	Gets a stretch fill rectangle. When stretching an image, the source rectangle is scaled to fit the specified fill rectangle.
Temperature	Gets the color temperature of the light source in the picture.
Tile	Gets the image tile format used to fill the available space.
Transparency	Gets or sets the degree of transparency of the image as a value between 0 (opaque) and 1 (clear). Allowed values are from 0 to 1, inclusive. The default is 0.
WebVideoProperties	Gets the properties for displaying an online video to the user.

Methods

Name	Description
Equals(ImageData)
Equals(object)
GetHashCode()
Recolor(RecolorType)	Changes the color of the image.
RecolorDark(UserColor)	Changes the color of the image. For each pixel, combines black color and specified `color` using a linear interpolation.
RecolorLight(UserColor)	Changes the color of the image. For each pixel, combines specified `color` and white color using a linear interpolation.
Save(Stream)	Saves the image into the specified stream.
SetColorTransparent(UserColor)	Makes a color in the current image transparent.
SetImage(byte[], string)	Sets the image that is displayed by this picture.
SetImage(Uri, string)	Sets the image that is displayed by this picture.
ToByteArray()	Returns a byte array representing the image, regardless of whether the image is stored or linked. If the image is linked, this method downloads the image each time it is called.
ToStream()	Creates and returns a stream containing the image bytes. If the image bytes are stored in the picture, creates and returns a MemoryStream object. If the image is linked and stored in a file, opens the file and returns a FileStream object. If the image is linked and stored in an external URL, downloads the file and returns a MemoryStream object.