API Reference
Class
ProjectImageExportBuilder
Fluent access to shared density presets, fonts, formats, bounded batches and file saving.
Inheritance
- OfficeImageExportBatchBuilder<ProjectImageExportBuilder, ProjectImageExportOptions>
- ProjectImageExportBuilder
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 ProjectImageExportBuilder.As
- Method ProjectImageExportBuilder.AsJpeg
- Method ProjectImageExportBuilder.AsPng
- Method ProjectImageExportBuilder.AsSvg
- Method ProjectImageExportBuilder.AsTiff
- Method ProjectImageExportBuilder.AsWebp
- Method ProjectImageExportBuilder.AtDpi
- Method ProjectImageExportBuilder.ConfigureOptions
- Method ProjectImageExportBuilder.FitWithin
- Method ProjectImageExportBuilder.FitWithinHeight
- Method ProjectImageExportBuilder.FitWithinWidth
- Method ProjectImageExportBuilder.ForPreview
- Method ProjectImageExportBuilder.ForPrint
- Method ProjectImageExportBuilder.OnFileConflict
- Method ProjectImageExportBuilder.OnRasterOverflow
- Method ProjectImageExportBuilder.WithBackground
- Method ProjectImageExportBuilder.WithBackground
- Method ProjectImageExportBuilder.WithBatchLimits
- Method ProjectImageExportBuilder.WithFont
- Method ProjectImageExportBuilder.WithFonts
- Method ProjectImageExportBuilder.WithImageCodec
- Method ProjectImageExportBuilder.WithMaximumConcurrency
- Method ProjectImageExportBuilder.WithMaximumRasterPixels
- Method ProjectImageExportBuilder.WithoutSizeLimit
- Method ProjectImageExportBuilder.WithPolicy
- Method ProjectImageExportBuilder.WithProgress
- Method ProjectImageExportBuilder.WithQuality
- Method ProjectImageExportBuilder.WithRasterEncoding
- Method ProjectImageExportBuilder.WithRenderTimeout
- Method ProjectImageExportBuilder.WithScale
- Method ProjectImageExportBuilder.WithTextShaping
- Method ProjectReportWorkflow.Images
Inherited Methods
public ProjectImageExportBuilder As(OfficeImageExportFormat format) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public ProjectImageExportBuilder AsJpeg() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder AsPng() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder AsSvg() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder AsTiff() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder AsWebp() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder AtDpi(Double dpi) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public ProjectImageExportBuilder ConfigureOptions(Action<ProjectImageExportOptions> configure) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<ProjectImageExportOptions>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public IReadOnlyList<OfficeImageExportResult> Export() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = default
public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = default) #Returns:
VoidInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportConsumer
- cancellationToken CancellationToken = default
public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = default) #Returns:
TaskInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportAsyncConsumer
- cancellationToken CancellationToken = default
public ProjectImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public ProjectImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public ProjectImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public ProjectImageExportBuilder ForPreview() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder ForPrint(Double dpi = 300) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public ProjectImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public ProjectImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = default
public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #Returns:
OfficeImageExportBatchSaveResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportBatchSaveResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = default
WithBackground 2 overloads
public ProjectImageExportBuilder WithBackground(OfficeColor color) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ProjectImageExportBuilder WithBackground(String color) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public ProjectImageExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public ProjectImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public ProjectImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public ProjectImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public ProjectImageExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public ProjectImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public ProjectImageExportBuilder WithoutSizeLimit() #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ProjectImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public ProjectImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public ProjectImageExportBuilder WithQuality(OfficeImageExportQuality quality) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- quality OfficeImageExportQuality
public ProjectImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public ProjectImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public ProjectImageExportBuilder WithScale(Double scale) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public ProjectImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
ProjectImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null