GrapeCity.Documents.Word.Picture

Class Picture

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a picture element in a body content.

public class Picture : ShapeBase, IBrowsable<Picture>

Inheritance

object

ContentObject

ShapeBase

Picture

Implements

IBrowsable<Picture>

Inherited Members

ShapeBase.Position

ShapeBase.Rotation

ShapeBase.Size

ShapeBase.WrapFormat

ShapeBase.BlackWhiteMode

ShapeBase.HyperlinkOnClick

ShapeBase.HyperlinkOnHover

ShapeBase.ParentRun

ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AlternativeText

Gets or sets the alternative text for the picture.

This text can be used by assistive technologies or applications that do not display the actual picture.

public override string AlternativeText { get; set; }

Property Value

string

Effects

Gets the shape effects formatting properties.

public ShapeEffects Effects { get; }

Property Value

ShapeEffects

Fill

Gets the fill formatting properties.

public FillFormat Fill { get; }

Property Value

FillFormat

GeometryType

Gets or sets a preset geometric shape type.

public GeometryType GeometryType { get; set; }

Property Value

GeometryType

Hidden

Gets or sets a value indicating whether this picture is hidden (i.e. present in the document but not visible).

Note that an application can have settings that allow this picture to be viewed.

public override bool Hidden { get; set; }

Property Value

bool

ID

Gets the unique ID of the current picture in the document.

public override uint ID { get; }

Property Value

uint

ImageData

Gets the ImageData representing this picture.

public ImageData ImageData { get; }

Property Value

ImageData

Line

Gets the line formatting properties.

public LineFormat Line { get; }

Property Value

LineFormat

Name

Gets or sets the current picture name.

Typically, this is used to store the original file name of the picture.

public override string Name { get; set; }

Property Value

string

Next

Gets the next picture.

public Picture Next { get; }

Property Value

Picture

Previous

Gets the previous picture.

public Picture Previous { get; }

Property Value

Picture

Style

Gets the style information for the picture.

public ShapeStyle Style { get; }

Property Value

ShapeStyle

Title

Gets or sets the title (caption) of this picture.

public override string Title { get; set; }

Property Value

string

Methods

ApplyEffectsPreset(ShapeEffectsPreset)

public void ApplyEffectsPreset(ShapeEffectsPreset preset)

Parameters

preset ShapeEffectsPreset

ApplyImageExifRotation()

Rotates the current Picture according to the Exif orientation info in ImageData (if available).

public bool ApplyImageExifRotation()

Returns

bool

true if the Exif data was found and the picture was rotated, false otherwise.

Remarks

Sometimes images may contain Exif orientation data that cannot be represented by rotation, for example the data may contain mirroring instructions. Such cases are ignored.

ApplyPreset(PicturePreset)

Applies a PicturePreset to this Picture.

Preset contains predefined fill, line, geometry and effects.

public void ApplyPreset(PicturePreset preset)

Parameters

preset PicturePreset

The preset to apply.