Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OdfShape

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Modifiers abstract

Shared XML-backed shape properties for OpenDocument presentations and drawings.

Inheritance

  • Object
  • OdfShape

Properties

public String Name { get; set; } #

Shape name.

public String XmlId { get; set; } #

XML identifier used by animation and cross-reference targets. Assigned values are unique across the main XML parts. Connector and animation references in the same page or master follow an identifier change.

public virtual String Transform { get; set; } #

Raw ODF/SVG transform expression.

public OfficeFillRule FillRule { get; set; } #

Rule used to fill overlapping contours; ODF follows SVG's nonzero default.

public Nullable<OdfColor> FillColor { get; set; } #

Solid shape fill color.

public Nullable<OdfColor> StrokeColor { get; set; } #

Shape stroke color, including dashed strokes.

public Nullable<OdfLength> StrokeWidth { get; set; } #

Shape stroke width.

public virtual OdfRect Bounds { get; set; } #

Position and size for shapes exposing SVG bounds.

public String FillGradientName { get; set; } #

Effective named gradient when the fill mode is gradient. Setting null explicitly disables the fill.

public Nullable<Int32> GradientStepCount { get; set; } #

Inherited gradient step count: zero selects automatic interpolation, three or more select fixed bands. Null removes the local override.

public String StrokeStartMarkerName { get; set; } #

Effective start marker. Setting null explicitly disables it, including an inherited marker.

public String StrokeEndMarkerName { get; set; } #

Effective end marker. Setting null explicitly disables it, including an inherited marker.

public Nullable<OdfLength> StrokeStartMarkerWidth { get; set; } #

Inherited absolute start-marker width; zero suppresses painting. Null removes the local override.

public Nullable<OdfLength> StrokeEndMarkerWidth { get; set; } #

Inherited absolute end-marker width; zero suppresses painting. Null removes the local override.

public Nullable<Boolean> StrokeStartMarkerCentered { get; set; } #

Whether the start marker is centered on its endpoint. Null removes the local override.

public Nullable<Boolean> StrokeEndMarkerCentered { get; set; } #

Whether the end marker is centered on its endpoint. Null removes the local override.

public Nullable<Double> FillOpacity { get; set; } #

Uniform fill opacity from zero to one, including inherited values. Null means no declared value.

public Nullable<Double> StrokeOpacity { get; set; } #

Stroke opacity from zero to one, including inherited values. Null means no declared value; assignment removes the local override.

public Nullable<Double> ImageOpacity { get; set; } #

Image-pixel opacity from zero to one, including inherited values. This is separate from the frame's fill opacity.

public Nullable<OfficeStrokeLineCap> StrokeLineCap { get; set; } #

Inherited stroke cap; null removes the local override and may restore an inherited value.

public Nullable<OfficeStrokeLineJoin> StrokeLineJoin { get; set; } #

Inherited miter, round, or bevel join; null removes the local override.

public String StrokeDashName { get; set; } #

Effective named dash pattern when the stroke is dashed. Setting null explicitly selects a solid stroke.

public Nullable<OdfTextFitMode> TextFitMode { get; set; } #

Inherited native text fitting; null removes both local fitting declarations.

Exceptions

  • NotSupportedException – The effective native pair contains unknown, legacy or conflicting active values.
  • ArgumentOutOfRangeException – The assigned mode is not defined.
public Nullable<OfficeTextAreaAlignment> TextAreaAlignment { get; set; } #

Inherited horizontal text-area placement; null removes the local override.

Exceptions

  • NotSupportedException – The effective native value is outside the supported alignment values.
public Nullable<OdfTextAreaVerticalAlignment> TextVerticalAlignment { get; set; } #

Inherited native vertical text-area placement; null removes the local override.

Exceptions

  • NotSupportedException – The effective native value is outside the supported alignment values.
public Nullable<Boolean> WrapText { get; set; } #

Inherited native wrapping declaration; null removes the local override.

Exceptions

  • NotSupportedException – The effective native wrapping declaration is unknown.
public Nullable<OdfInsets> TextPadding { get; set; } #

Inherited top, right, bottom, and left text insets; null removes all local padding declarations.

Exceptions

  • ArgumentException – An assigned side is not a finite nonnegative absolute ODF schema length.
public Nullable<Boolean> AutoGrowHeight { get; set; } #

Inherited native text-box height growth; null removes the local declaration.

Exceptions

  • NotSupportedException – The effective declaration is not an ODF boolean.
public Nullable<Boolean> AutoGrowWidth { get; set; } #

Inherited native text-box width growth; null removes the local declaration.

Exceptions

  • NotSupportedException – The effective declaration is not an ODF boolean.
public Nullable<OdfLength> TextBoxMinimumHeight { get; set; } #

Instance minimum height on the direct text-box container; null removes the attribute.

public Nullable<OdfLength> TextBoxMinimumWidth { get; set; } #

Instance minimum width on the direct text-box container; null removes the attribute.

public Nullable<OdfLength> TextBoxMaximumHeight { get; set; } #

Instance maximum height on the direct text-box container; null removes the attribute.

public Nullable<OdfLength> TextBoxMaximumWidth { get; set; } #

Instance maximum width on the direct text-box container; null removes the attribute.