Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 570 stars PSWriteOfficePowerShell module 164 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OdgShapes

Edit on GitHub
Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Source ../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Connectors.cs:8
Implements
IReadOnlyList<OdgShape> IReadOnlyCollection<OdgShape> IEnumerable<OdgShape> IEnumerable
Modifiers sealed
Attributes
DefaultMember("Item")

An editable drawing-page, master or group collection. Unknown drawing elements remain visible and preserved.

Inheritance

  • Object
  • OdgShapes

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

AddConnector 2 overloads
public OdgShape AddConnector(OfficePoint start, OfficePoint end, OdgConnectorKind kind = Line, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Connectors.cs:8
Returns: OdgShape

Adds a connector between free points in this collection's coordinate space.

Parameters

start OfficeIMO.Drawing.OfficePoint requiredposition: 0
end OfficeIMO.Drawing.OfficePoint requiredposition: 1
kind OfficeIMO.OpenDocument.OdgConnectorKind = Line optionalposition: 2
name System.String = null optionalposition: 3
public OdgShape AddConnector(OdgGluePoint start, OdgGluePoint end, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:52
Returns: OdgShape

Adds a straight connector attached to two explicit glue points on this page or master.

Parameters

start OfficeIMO.OpenDocument.OdgGluePoint requiredposition: 0
end OfficeIMO.OpenDocument.OdgGluePoint requiredposition: 1
name System.String = null optionalposition: 2
public OdgShape AddEllipse(OdfRect bounds, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:28
Returns: OdgShape

Adds an ellipse.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
name System.String = null optionalposition: 1
public OdgShape AddGroup(String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:71
Returns: OdgShape

Adds a group; its Children collection accepts the same shape operations.

Parameters

name System.String = null optionalposition: 0
public OdgShape AddImage(Byte[] data, String fileName, OdfRect bounds, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:37
Returns: OdgShape

Adds an embedded image using the existing ODF image store.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String requiredposition: 1
bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 2
name System.String = null optionalposition: 3
public OdgShape AddLine(OdfLength x1, OdfLength y1, OdfLength x2, OdfLength y2, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:45
Returns: OdgShape

Adds a line with absolute page coordinates.

Parameters

x1 OfficeIMO.OpenDocument.OdfLength requiredposition: 0
y1 OfficeIMO.OpenDocument.OdfLength requiredposition: 1
x2 OfficeIMO.OpenDocument.OdfLength requiredposition: 2
y2 OfficeIMO.OpenDocument.OdfLength requiredposition: 3
name System.String = null optionalposition: 4
AddPath 2 overloads
public OdgShape AddPath(OdfRect bounds, OdfViewBox viewBox, String pathData, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Geometry.cs:13
Returns: OdgShape

Adds a path whose SVG data uses the supplied local view box and is scaled to the page bounds.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
viewBox OfficeIMO.OpenDocument.OdfViewBox requiredposition: 1
pathData System.String requiredposition: 2
name System.String = null optionalposition: 3
public OdgShape AddPath(OdfRect bounds, OdfViewBox viewBox, IEnumerable<OfficePathCommand> commands, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Geometry.cs:18
Returns: OdgShape

Adds a path using shared Drawing commands in the supplied local view box.

Parameters

arg1 OfficeIMO.OpenDocument.OdfRect requiredposition: 0
arg2 OfficeIMO.OpenDocument.OdfViewBox requiredposition: 1
arg3 System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePathCommand} requiredposition: 2
arg4 System.String = null optionalposition: 3
public OdgShape AddPolygon(OdfRect bounds, OdfViewBox viewBox, IEnumerable<OfficePoint> points, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Geometry.cs:21
Returns: OdgShape

Adds a closed polygon using integer coordinates in the supplied local view box.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
viewBox OfficeIMO.OpenDocument.OdfViewBox requiredposition: 1
points System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePoint} requiredposition: 2
name System.String = null optionalposition: 3
public OdgShape AddPolyline(OdfRect bounds, OdfViewBox viewBox, IEnumerable<OfficePoint> points, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Geometry.cs:24
Returns: OdgShape

Adds an open polyline using integer coordinates in the supplied local view box; its initial fill is none.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
viewBox OfficeIMO.OpenDocument.OdfViewBox requiredposition: 1
points System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePoint} requiredposition: 2
name System.String = null optionalposition: 3
public OdgShape AddRectangle(OdfRect bounds, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:26
Returns: OdgShape

Adds a rectangle.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
name System.String = null optionalposition: 1
public OdgShape AddRoundedRectangle(OdfRect bounds, OdfLength radius, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.Geometry.cs:8
Returns: OdgShape

Adds a rectangle with circular corners. Oversized radii are clamped during rendering.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
radius OfficeIMO.OpenDocument.OdfLength requiredposition: 1
name System.String = null optionalposition: 2
public OdgShape AddTextBox(OdfRect bounds, String text, String name = null) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:31
Returns: OdgShape

Adds a text frame.

Parameters

bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 0
text System.String requiredposition: 1
name System.String = null optionalposition: 2
public IEnumerator<OdgShape> GetEnumerator() #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:112
Returns: IEnumerator<OdgShape>

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

public Void Move(Int32 sourceIndex, Int32 destinationIndex) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:101
Returns: Void

Changes a shape's paint-order position.

Parameters

sourceIndex System.Int32 requiredposition: 0
destinationIndex System.Int32 requiredposition: 1
public Void RemoveAt(Int32 index) #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:74
Returns: Void

Removes one shape, including its children.

Parameters

index System.Int32 requiredposition: 0

Properties

public Int32 Count { get; } #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:22

Number of shapes.

public OdgShape this[Int32 index] { get; } #
../../../../_/OfficeIMO.OpenDocument/Drawing/OdgShapes.cs:24

Shape at a zero-based paint-order position.

Parameters

arg1 System.Int32 requiredposition: 0