# OfficeImagePatternLayout

Describes a clipped image pattern with independently sized tiles and repeat steps in drawing coordinates.

Struct 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeImagePatternLayout.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L15)

**Base**

`ValueType`

**Modifiers**

sealed

Describes a clipped image pattern with independently sized tiles and repeat steps in drawing coordinates.

## Inheritance

- ValueType
- OfficeImagePatternLayout

## Usage

Explore 5 API references to this type

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

### Returned or exposed by 3

- Property [OfficeDrawingImagePattern.Layout](/api/core/officeimo-drawing-officedrawingimagepattern/#property-layout)
- Method [OfficeImagePatternLayout.Scale](/api/core/officeimo-drawing-officeimagepatternlayout/#method-scale-double)
- Method [OfficeImagePatternLayout.Translate](/api/core/officeimo-drawing-officeimagepatternlayout/#method-translate-double-double)

### Accepted by parameters 2

- Method [OfficeDrawing.AddImagePattern](/api/core/officeimo-drawing-officedrawing/#method-addimagepattern-byte-string-officeimo-drawing-officeimagepatternlayout-int32-double) parameter `layout`
- Constructor [OfficeDrawingImagePattern.OfficeDrawingImagePattern](/api/core/officeimo-drawing-officedrawingimagepattern/#constructor-ctor-byte-string-officeimo-drawing-officeimagepatternlayout-int32-double) parameter `layout`

Filter members 

Show inherited

## Constructors

OfficeImagePatternLayout 2 overloads

`public OfficeImagePatternLayout(OfficeImagePlacement area, OfficeImagePlacement tile, bool repeatX, bool repeatY)` [#](#constructor-ctor-officeimo-drawing-officeimageplacement-officeimo-drawing-officeimageplacement-boolean-boolean)

[OfficeImagePatternLayout.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L15)

Creates a pattern layout using the tile dimensions as repeat steps.

Parameters

**area OfficeIMO.Drawing.OfficeImagePlacement required**

**tile OfficeIMO.Drawing.OfficeImagePlacement required**

**repeatX bool required**

**repeatY bool required**

`public OfficeImagePatternLayout(OfficeImagePlacement area, OfficeImagePlacement tile, bool repeatX = true, bool repeatY = true, double? horizontalStep = null, double? verticalStep = null)` [#](#constructor-ctor-officeimo-drawing-officeimageplacement-officeimo-drawing-officeimageplacement-boolean-boolean-nullable-system-double-nullable-system-double)

[OfficeImagePatternLayout.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L26)

Creates a pattern layout from a paint area and one positioned tile.

Parameters

**area OfficeIMO.Drawing.OfficeImagePlacement required**

**tile OfficeIMO.Drawing.OfficeImagePlacement required**

**repeatX bool = true optional**

**repeatY bool = true optional**

**horizontalStep double? = null optional**

**verticalStep double? = null optional**

## Methods

`public IReadOnlyList<OfficeImagePlacement> GetTilePlacements(int maximumTileCount)` [#](#method-gettileplacements-int32)

[OfficeImagePatternLayout.cs:70](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L70)

Returns all full tile placements intersecting the clipped area within an explicit safety limit.

Parameters

**maximumTileCount int required**

Returns

`IReadOnlyList<OfficeImagePlacement>`

`public OfficeImagePatternLayout Scale(double scale)` [#](#method-scale-double)

[OfficeImagePatternLayout.cs:115](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L115)

Returns a uniformly scaled pattern layout.

Parameters

**scale double required**

Returns

`OfficeImagePatternLayout`

`public OfficeImagePatternLayout Translate(double offsetX, double offsetY)` [#](#method-translate-double-double)

[OfficeImagePatternLayout.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L102)

Returns a translated pattern layout.

Parameters

**offsetX double required**

**offsetY double required**

Returns

`OfficeImagePatternLayout`

## Inherited Methods

`public override bool Equals(object? obj)` [#](#method-equals-object)

Inherited from ValueType

Parameters

**obj object? required**

Returns

`bool`

`public override int GetHashCode()` [#](#method-gethashcode)

Inherited from ValueType

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public override string? ToString()` [#](#method-tostring)

Inherited from ValueType

Returns

`string?`

## Properties

`public OfficeImagePlacement Area { get; }` [#](#property-area)

[OfficeImagePatternLayout.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L39)

Clipped destination area painted by the pattern.

`public OfficeImagePlacement Tile { get; }` [#](#property-tile)

[OfficeImagePatternLayout.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L42)

Position and size of the authored origin tile.

`public bool RepeatX { get; }` [#](#property-repeatx)

[OfficeImagePatternLayout.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L45)

Whether the origin tile repeats horizontally.

`public bool RepeatY { get; }` [#](#property-repeaty)

[OfficeImagePatternLayout.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L48)

Whether the origin tile repeats vertically.

`public double HorizontalStep { get; }` [#](#property-horizontalstep)

[OfficeImagePatternLayout.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L51)

Distance between horizontal tile origins.

`public double VerticalStep { get; }` [#](#property-verticalstep)

[OfficeImagePatternLayout.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L54)

Distance between vertical tile origins.

`public long EstimatedTileCount { get; }` [#](#property-estimatedtilecount)

[OfficeImagePatternLayout.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImagePatternLayout.cs#L59)

Number of tiles intersecting the clipped area, saturated at long.MaxValue.

<!-- PowerForge markdown artifact sha256:9F5068D007FF6C4411902CC9D2B98663EDBC8D4F9508FEF2AA864217417A05D9 -->
