Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 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

OfficeImageReader

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source ../../../../_/OfficeIMO.Core/OfficeImageReader.cs:18
Modifiers static

Bounded image metadata reader used to avoid full image decoding dependencies.

Inheritance

  • Object
  • OfficeImageReader

Methods

public static OfficeImageFormat FromExtension(String fileName) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:249
Returns: OfficeImageFormat

Maps a file name or extension to a supported image format.

Parameters

fileName System.String requiredposition: 0
Identify 2 overloads
public static OfficeImageInfo Identify(String filePath) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:18
Returns: OfficeImageInfo

Identifies image metadata from a file.

Parameters

filePath System.String requiredposition: 0
public static OfficeImageInfo Identify(Byte[] data, String fileName = null) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:30
Returns: OfficeImageInfo

Identifies image metadata from a byte array.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String = null optionalposition: 1
public static Boolean IsKnownImageExtension(String fileName) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:306
Returns: Boolean

Returns whether the file name or extension maps to an image format known by the shared drawing layer.

Parameters

fileName System.String requiredposition: 0
File name, path, or bare extension.

Returns

true when the extension maps to a known image format.

TryIdentify 2 overloads
public static Boolean TryIdentify(Stream stream, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:41
Returns: Boolean

Tries to identify image metadata from a stream.

Parameters

stream System.IO.Stream requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
public static Boolean TryIdentify(Byte[] data, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:121
Returns: Boolean

Tries to identify image metadata from a byte array.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
TryIdentifyByContent 2 overloads
public static Boolean TryIdentifyByContent(Stream stream, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:50
Returns: Boolean

Tries to identify image metadata from a stream while requiring the content to match a supported format. The file name may select a content parser but cannot identify the image by extension alone.

Parameters

stream System.IO.Stream requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
public static Boolean TryIdentifyByContent(Byte[] data, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:137
Returns: Boolean

Tries to identify image metadata from a byte array while requiring the content to match a supported format. The file name may select a content parser but cannot identify the image by extension alone.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
TryValidateContent 4 overloads
public static Boolean TryValidateContent(Stream stream, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:59
Returns: Boolean

Validates a complete bounded image payload and returns its metadata. Unlike metadata identification, this decodes supported PNG, JPEG, GIF, BMP, TIFF, and WebP payloads and validates every ICO entry so structurally plausible but incomplete image bodies are rejected.

Parameters

stream System.IO.Stream requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
public static Boolean TryValidateContent(Stream stream, String fileName, CancellationToken cancellationToken, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:71
Returns: Boolean

Validates a complete bounded image payload and observes cancellation while reading, parsing, and decoding the payload.

Parameters

stream System.IO.Stream requiredposition: 0
fileName System.String requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 3
public static Boolean TryValidateContent(Byte[] data, String fileName, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:153
Returns: Boolean

Validates a complete bounded image payload and returns its metadata. Unlike metadata identification, this decodes supported PNG, JPEG, GIF, BMP, TIFF, and WebP payloads and validates every ICO entry so structurally plausible but incomplete image bodies are rejected.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String requiredposition: 1
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 2
public static Boolean TryValidateContent(Byte[] data, String fileName, CancellationToken cancellationToken, out OfficeImageInfo info) #
../../../../_/OfficeIMO.Core/OfficeImageReader.cs:164
Returns: Boolean

Validates a complete bounded image payload and observes cancellation while parsing and decoding it.

Parameters

data System.Byte[] requiredposition: 0
fileName System.String requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
info OfficeIMO.Drawing.OfficeImageInfo@ requiredposition: 3