IPicture module

class IPicture.IPicture

Bases: IParagraphBase, IDocumentObject

Represents an interface for a picture in a document.

abstract AddCaption(name: str, format: CaptionNumberingFormat, captionPosition: CaptionPosition) → IParagraph

Adds a caption to the picture.

Parameters:

name (str) – The name of the caption.
format (CaptionNumberingFormat) – The numbering format of the caption.
captionPosition (CaptionPosition) – The position of the caption.

Returns:

The paragraph containing the caption.

Return type:

abstract property AlternativeText: str: Gets or sets the alternative text of the picture.

abstract property Height: float: Gets or sets the height of the picture.

abstract property HeightScale: float: Gets or sets the height scale of the picture.

abstract property HorizontalAlignment: ShapeHorizontalAlignment: Gets or sets the horizontal alignment of the picture.

abstract property HorizontalOrigin: HorizontalOrigin: Gets or sets the horizontal origin of the picture.

abstract property HorizontalPosition: float: Gets or sets the horizontal position of the picture.

abstract property IsUnderText: bool: Gets or sets a value indicating whether the picture is under the text.

abstract property TextWrappingStyle: TextWrappingStyle: Gets or sets the text wrapping style of the picture.

abstract property TextWrappingType: TextWrappingType: Gets or sets the text wrapping type of the picture.

abstract property Title: str: Gets or sets the title of the picture.

abstract property VerticalAlignment: ShapeVerticalAlignment: Gets or sets the vertical alignment of the picture.

abstract property VerticalOrigin: VerticalOrigin: Gets or sets the vertical origin of the picture.

abstract property VerticalPosition: float: Gets or sets the vertical position of the picture.

abstract property Width: float: Gets or sets the width of the picture.

abstract property WidthScale: float: Gets or sets the width scale of the picture.