Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Struct

OfficeImagePatternLayout

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Base ValueType
Modifiers sealed

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

Inheritance

  • ValueType
  • OfficeImagePatternLayout

Usage

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

Accepted by parameters

Constructors

OfficeImagePatternLayout 2 overloads
public OfficeImagePatternLayout(OfficeImagePlacement area, OfficeImagePlacement tile, Boolean repeatX, Boolean repeatY) #

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

Parameters

area OfficeIMO.Drawing.OfficeImagePlacement requiredposition: 0
tile OfficeIMO.Drawing.OfficeImagePlacement requiredposition: 1
repeatX System.Boolean requiredposition: 2
repeatY System.Boolean requiredposition: 3
public OfficeImagePatternLayout(OfficeImagePlacement area, OfficeImagePlacement tile, Boolean repeatX = true, Boolean repeatY = true, Nullable<Double> horizontalStep = null, Nullable<Double> verticalStep = null) #

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

Parameters

area OfficeIMO.Drawing.OfficeImagePlacement requiredposition: 0
tile OfficeIMO.Drawing.OfficeImagePlacement requiredposition: 1
repeatX System.Boolean = true optionalposition: 2
repeatY System.Boolean = true optionalposition: 3
horizontalStep System.Nullable{System.Double} = null optionalposition: 4
verticalStep System.Nullable{System.Double} = null optionalposition: 5

Methods

public IReadOnlyList<OfficeImagePlacement> GetTilePlacements(Int32 maximumTileCount) #
Returns: IReadOnlyList<OfficeImagePlacement>

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

Parameters

maximumTileCount System.Int32 requiredposition: 0
public OfficeImagePatternLayout Scale(Double scale) #
Returns: OfficeImagePatternLayout

Returns a uniformly scaled pattern layout.

Parameters

scale System.Double requiredposition: 0
public OfficeImagePatternLayout Translate(Double offsetX, Double offsetY) #
Returns: OfficeImagePatternLayout

Returns a translated pattern layout.

Parameters

offsetX System.Double requiredposition: 0
offsetY System.Double requiredposition: 1

Properties

public OfficeImagePlacement Area { get; } #

Clipped destination area painted by the pattern.

public OfficeImagePlacement Tile { get; } #

Position and size of the authored origin tile.

public Boolean RepeatX { get; } #

Whether the origin tile repeats horizontally.

public Boolean RepeatY { get; } #

Whether the origin tile repeats vertically.

public Double HorizontalStep { get; } #

Distance between horizontal tile origins.

public Double VerticalStep { get; } #

Distance between vertical tile origins.

public Int64 EstimatedTileCount { get; } #

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