API Reference
OfficeDocumentAsset
Asset metadata emitted by a document read adapter.
Inheritance
- Object
- OfficeDocumentAsset
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
- Method DocumentReader.ExtractAssets
- Method DocumentReader.ReadAssets
- Method DocumentReader.ReadAssets
- Property OfficeDocumentAssetDataUriOptions.Predicate
- Property OfficeDocumentAssetMaterializationOptions.Predicate
- Property OfficeDocumentMaterializedAsset.Asset
- Property OfficeDocumentPage.Assets
- Property OfficeDocumentReadResult.Assets
Accepted by parameters
- Method DocumentReader.ExtractAssets
- Extension method OfficeDocumentAsset.PayloadHashMatches
- Extension method OfficeDocumentAsset.TryBuildDataUri
- Method OfficeDocumentAssetDataUri.TryBuildDataUri
- Method OfficeDocumentAssetHash.PayloadHashMatches
- Method OfficeDocumentAssetMaterializer.StreamAssets
- Extension method OfficeDocumentReadResult.StreamAssets
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 MediaType { get; set; } #Media type when known.
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 Nullable<Int32> Width { get; set; } #Width in pixels or source units when known.
public Nullable<Int32> Height { get; set; } #Height in pixels or source units when known.
public Nullable<Int64> LengthBytes { get; set; } #Asset byte length when known.
public String PayloadHash { get; set; } #Stable payload hash when available.
public Byte[] PayloadBytes { get; set; } #Optional 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 ReaderLocation Location { get; set; } #Source location for this asset.
Extension Methods
public static Boolean PayloadHashMatches(OfficeDocumentAsset asset, out String actualHash) #BooleanChecks whether an asset payload matches its declared payload hash.
Parameters
- asset OfficeIMO.Reader.OfficeDocumentAsset
- Asset to validate.
- actualHash System.String@
- Computed SHA-256 hash when validation could run.
public static Boolean TryBuildDataUri(OfficeDocumentAsset asset, out String dataUri, Nullable<Int64> maxInlineBytes = 65536) #BooleanBuilds 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 System.String@
- Data URI when one could be built.
- maxInlineBytes System.Nullable{System.Int64} = 65536
- Maximum payload size to inline. Set to null for no size cap.