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 WordDocumentImageExportBuilder.As
- Method WordDocumentImageExportBuilder.AsPng
- Method WordDocumentImageExportBuilder.AsSvg
- Method WordDocumentImageExportBuilder.FirstPage
- Method WordDocumentImageExportBuilder.ForHighResolution
- Method WordDocumentImageExportBuilder.ForPreview
- Method WordDocumentImageExportBuilder.IncludeContent
- Method WordDocumentImageExportBuilder.Page
- Method WordDocumentImageExportBuilder.WithBackground
- Method WordDocumentImageExportBuilder.WithoutContent
- Method WordDocumentImageExportBuilder.WithScale
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 AsPng() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder AsSvg() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public OfficeImageExportResult Export() #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder ForHighResolution() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentImageExportBuilder ForPreview() #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OfficeImageExportResult Save(Stream stream) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
- cancellationToken CancellationToken = null
public WordDocumentImageExportBuilder WithBackground(String color) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public WordDocumentImageExportBuilder WithScale(Double scale) #Returns:
WordDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double