Picture Class

Represents a picture.

Inheritance Hierarchy

SystemObject
  GemBox.DocumentElement
    GemBox.DocumentInline
      GemBox.Document.DrawingDrawingElement
        GemBox.Document.DrawingShape
          GemBox.DocumentPicture

Namespace: GemBox.Document
Assembly: GemBox.Document (in GemBox.Document.dll) Version: 31.0.35.1215

Syntax

Copy

public sealed class Picture : Shape

Public NotInheritable Class Picture
	Inherits Shape

The Picture type exposes the following members.

Constructors

	Name	Description
	Picture(DocumentModel, Stream)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, String)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, String, Boolean)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, MemoryStream, Layout, ShapeType)	Initializes a new instance of the Picture class with specified layout (position and size), clipping geometry and picture's pixel data stream.
	Picture(DocumentModel, MemoryStream, PictureFormat, Layout)	Initializes a new instance of the Picture class with specified layout (position and size) and picture's pixel data stream and format.
	Picture(DocumentModel, MemoryStream, Double, Double)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, Stream, Double, Double)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, String, Double, Double)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, MemoryStream, PictureFormat, Layout, ShapeType)	Initializes a new instance of the Picture class with specified layout (position and size), clipping geometry and picture's pixel data stream and format.
	Picture(DocumentModel, MemoryStream, PictureFormat, Double, Double)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, MemoryStream, Double, Double, LengthUnit)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data in-memory stream and picture's size.
	Picture(DocumentModel, Stream, PictureFormat, Double, Double)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, Stream, Double, Double, LengthUnit)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data stream and picture's size.
	Picture(DocumentModel, String, Double, Double, LengthUnit)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data file path and picture's size.
	Picture(DocumentModel, String, Double, Double, Boolean)	Initializes a new instance of the Picture class.
	Picture(DocumentModel, MemoryStream, PictureFormat, Double, Double, LengthUnit)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data in-memory stream and format and picture's size.
	Picture(DocumentModel, Stream, PictureFormat, Double, Double, LengthUnit)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data stream and format and picture's size.
	Picture(DocumentModel, String, Double, Double, LengthUnit, Boolean)	Initializes a new instance of the Picture class positioned in-line with specified picture's pixel data file path and picture's size.

Top

Properties

	Name	Description
	AdjustValues	Gets the shape's adjust values. (Inherited from Shape.)
	Content	Gets the content of the current Element. (Inherited from Element.)
	Document	Gets the owner document. (Inherited from Element.)
	ElementType	Gets the element type for Picture which is Picture. (Overrides ShapeElementType.)
	Fill	Gets the Brush that specifies how the shape's interior is filled. (Inherited from Shape.)
	Format	Gets the image file format.
	Layout	Gets or sets the DrawingElement layout (position and size). (Inherited from DrawingElement.)
	Link	Gets or sets the link to the external picture.
	Metadata	Gets the metadata (non-visual properties) of this DrawingElement instance. (Inherited from DrawingElement.)
	Outline	Gets the Pen that specifies the shape's outline. (Inherited from Shape.)
	Parent	Gets the parent of this Element instance. (Inherited from Element.)
	ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline.)
	PictureStream	Gets or sets the stream that contains the image.
	ShapeType	Gets the type of the shape. (Inherited from Shape.)

Top

Methods

	Name	Description
	Clone	Clones this Picture instance.
	Clone(Boolean)	Clones this Shape instance. (Inherited from Shape.)
	GetChildElements(Boolean)	Gets the child elements. (Inherited from Element.)
	GetChildElements(Boolean, ElementType)	Gets the child elements filtered by ElementType. (Inherited from Element.)

Top

Remarks

Picture is a Shape that enables inserting a bitmap, which consists of the pixel data for a graphics image and its attributes, within a document content.

Picture.PictureStream and Picture.Format properties define a Picture and are mandatory in a Picture constructors, directly or indirectly.

Picture can be clipped to a specific shape. Clipping shape type is represented by ShapeType enumeration. It can be set only through Picture(DocumentModel, MemoryStream, PictureFormat, Layout, ShapeType) constructor and retrieved from ShapeType property.

Picture can be filled with a Brush (which will be visible if picture has transparent pixel data) and outlined with a Pen.

Picture can be positioned in-line with the rest of the document content or floating within document content. For more information about picture positioning, see remarks for DrawingElement.Layout property.

For more information, see pictures example.

Reference

GemBox.Document Namespace

Other Resources

GemBox.Document Content Model

GemBox.Document Shapes and Layout

Pictures example