OfficeDocumentAsset
OfficeIMO.Reader
Asset metadata emitted by a document read adapter.
Inheritance
- object
- OfficeDocumentAsset
Usage
Explore 16 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 7
- Property OfficeDocumentAssetDataUriOptions.Predicate
- Property OfficeDocumentAssetMaterializationOptions.Predicate
- Property OfficeDocumentMaterializedAsset.Asset
- Property OfficeDocumentPage.Assets
- Extension method OfficeDocumentReadResult.ExtractAssets
- Property OfficeDocumentReadResult.Assets
- Method OfficeDocumentReadResultExtensions.ExtractAssets
Accepted by parameters 9
- Extension method OfficeDocumentAsset.PayloadHashMatches
- Extension method OfficeDocumentAsset.TryBuildDataUri
- Method OfficeDocumentAssetDataUri.TryBuildDataUri
- Constructor OfficeDocumentAssetFilterProcessor.OfficeDocumentAssetFilterProcessor
- Method OfficeDocumentAssetHash.PayloadHashMatches
- Method OfficeDocumentAssetMaterializer.StreamAssets
- Extension method OfficeDocumentReadResult.ExtractAssets
- Extension method OfficeDocumentReadResult.StreamAssets
- Method OfficeDocumentReadResultExtensions.ExtractAssets
Constructors
public OfficeDocumentAsset() #Inherited Methods
Properties
public string Id { get; set; } #Stable asset identifier within the read result.
public string Kind { get; set; } #Normalized asset kind, such as image or preview.
public string? Extension { get; set; } #Suggested file extension when known.
public string? FileName { get; set; } #Deterministic suggested filename for writing this asset outside the read result envelope.
public string? AltText { get; set; } #Accessibility description or alternate text when available from the source document.
public string? Title { get; set; } #Source title or caption-like label when available from the asset metadata.
public int? Width { get; set; } #Width in pixels or source units when known.
public int? Height { get; set; } #Height in pixels or source units when known.
public long? LengthBytes { get; set; } #Asset byte length when known.
public string? PayloadHash { get; set; } #Stable payload hash when available.
public byte[]? PayloadBytes { get; set; } #JsonIgnoreOptional in-memory payload for callers that request materializable assets. This payload is not included in JSON transport output.
public string? SourceObjectId { get; set; } #Source-specific relationship, resource, or object identifier.
public OfficeDocumentRegion? Region { get; set; } #Source geometry for this asset when the read adapter can locate a concrete placement.
public ReaderLocation Location { get; set; } #Source location for this asset.
Extension Methods
public static bool PayloadHashMatches(OfficeDocumentAsset asset, out string? actualHash) #Checks whether an asset payload matches its declared payload hash.
Parameters
- asset OfficeIMO.Reader.OfficeDocumentAsset
- Asset to validate.
- actualHash string?
- Computed SHA-256 hash when validation could run.
Returns
boolpublic static bool TryBuildDataUri(OfficeDocumentAsset asset, out string? dataUri, long? maxInlineBytes = 65536) #Builds a data URI for an asset payload when the payload exists and fits the configured size cap.
Parameters
- asset OfficeIMO.Reader.OfficeDocumentAsset
- Asset to encode.
- dataUri string?
- Data URI when one could be built.
- maxInlineBytes long? = 65536
- Maximum payload size to inline. Set to null for no size cap.
Returns
bool