Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OdgBackground

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Modifiers sealed

XML-backed background paint in a page or master's drawing-page style chain.

Inheritance

  • Object
  • OdgBackground

Remarks

Page declarations override master paint except for native no-fill, which retains the master. Master edits affect all referencing pages. Referenced gradient definitions and image bytes remain shared.

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

public Byte[] GetBitmapBytes() #
Returns: Byte[]

Returns embedded bitmap source bytes without fetching linked content.

public Void SetBitmap(Byte[] data, String fileName = "background.png") #
Returns: Void

Embeds a supported raster and selects stretched bitmap fill without changing opacity or paint area.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String = "background.png" optionalposition: 1
public Void UseNoFill() #
Returns: Void

Selects native no-fill, retaining inactive declarations and resource definitions.

Properties

public String FillMode { get; } #

Resolved native fill token in this owner's style chain, or null when absent. It does not include the other owner's paint.

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

Resolved solid fill color, or null for another fill mode. Setting null selects native no-fill.

public String FillGradientName { get; set; } #

Resolved gradient binding, or null for another fill mode. Setting null selects native no-fill.

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

Uniform opacity from zero to one in this owner's style chain. Null removes the local override.

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

Resolved native gradient band count. Zero means automatic; three or more means fixed bands. Null removes the local override.

public String FillImageName { get; } #

Resolved bitmap definition name, or null for another fill mode.