API Reference
Class
WordDocumentImageExportBuilder
Fluent image-export builder for a Word document page preview.
Inheritance
- OfficeImageExportBuilder<WordDocumentImageExportBuilder, WordImageExportOptions>
- WordDocumentImageExportBuilder
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 WordDocument.ToImage
- Method WordDocument.ToImage
- Method WordDocumentImageExportBuilder.As
- Method WordDocumentImageExportBuilder.AsJpeg
- Method WordDocumentImageExportBuilder.AsPng
- Method WordDocumentImageExportBuilder.AsSvg
- Method WordDocumentImageExportBuilder.AsTiff
- Method WordDocumentImageExportBuilder.AsWebp
- Method WordDocumentImageExportBuilder.AtDpi
- Method WordDocumentImageExportBuilder.ConfigureOptions
- Method WordDocumentImageExportBuilder.FirstPage
- Method WordDocumentImageExportBuilder.FitWithin
- Method WordDocumentImageExportBuilder.FitWithinHeight
- Method WordDocumentImageExportBuilder.FitWithinWidth
- Method WordDocumentImageExportBuilder.ForPreview
- Method WordDocumentImageExportBuilder.ForPrint
- Method WordDocumentImageExportBuilder.IncludeContent
- Method WordDocumentImageExportBuilder.OnFileConflict
- Method WordDocumentImageExportBuilder.OnRasterOverflow
- Method WordDocumentImageExportBuilder.Page
- Method WordDocumentImageExportBuilder.WithBackground
- Method WordDocumentImageExportBuilder.WithBackground
- Method WordDocumentImageExportBuilder.WithFont
- Method WordDocumentImageExportBuilder.WithFonts
- Method WordDocumentImageExportBuilder.WithImageCodec
- Method WordDocumentImageExportBuilder.WithMaximumRasterPixels
- Method WordDocumentImageExportBuilder.WithoutContent
- Method WordDocumentImageExportBuilder.WithoutSizeLimit
- Method WordDocumentImageExportBuilder.WithPolicy
- Method WordDocumentImageExportBuilder.WithProgress
- Method WordDocumentImageExportBuilder.WithRasterEncoding
- Method WordDocumentImageExportBuilder.WithRenderTimeout
- Method WordDocumentImageExportBuilder.WithScale
- Method WordDocumentImageExportBuilder.WithTextShaping
Methods
public WordDocumentImageExportBuilder FirstPage() #Returns:
WordDocumentImageExportBuilderExports the first page preview.
public WordDocumentImageExportBuilder IncludeContent(Boolean include = true) #Returns:
WordDocumentImageExportBuilderIncludes or excludes document body content.
Parameters
- include System.Boolean = true
public WordDocumentImageExportBuilder Page(Int32 pageIndex) #Returns:
WordDocumentImageExportBuilderSets the zero-based page index to export.
Parameters
- pageIndex System.Int32
public WordDocumentImageExportBuilder WithoutContent() #Returns:
WordDocumentImageExportBuilderExcludes document body content.
Inherited Methods
public WordDocumentImageExportBuilder As(OfficeImageExportFormat format) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public WordDocumentImageExportBuilder AsJpeg() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AsPng() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AsSvg() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AsTiff() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AsWebp() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AtDpi(Double dpi) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public WordDocumentImageExportBuilder ConfigureOptions(Action<WordImageExportOptions> configure) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<WordImageExportOptions>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Export 2 overloads
public OfficeImageExportResult Export() #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OfficeImageExportResult Export(CancellationToken cancellationToken) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken
public async Task<OfficeImageExportResult> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public WordDocumentImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public WordDocumentImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public WordDocumentImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public WordDocumentImageExportBuilder ForPreview() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder ForPrint(Double dpi = 300) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public WordDocumentImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public WordDocumentImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
Save 2 overloads
public OfficeImageExportResult Save(String path) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
public OfficeImageExportResult Save(Stream stream) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
SaveAsync 2 overloads
public async Task<OfficeImageExportResult> SaveAsync(String path, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
- cancellationToken CancellationToken = null
public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
- cancellationToken CancellationToken = null
WithBackground 2 overloads
public WordDocumentImageExportBuilder WithBackground(OfficeColor color) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public WordDocumentImageExportBuilder WithBackground(String color) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public WordDocumentImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public WordDocumentImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public WordDocumentImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public WordDocumentImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public WordDocumentImageExportBuilder WithoutSizeLimit() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public WordDocumentImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public WordDocumentImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public WordDocumentImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public WordDocumentImageExportBuilder WithScale(Double scale) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public WordDocumentImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null