API Reference
Class
EmailImageExportBuilder
Fluent image export for one rendered email surface.
Inheritance
- OfficeImageExportBuilder<EmailImageExportBuilder, EmailImageExportOptions>
- EmailImageExportBuilder
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 EmailImageExportBuilder.As
- Method EmailImageExportBuilder.AsJpeg
- Method EmailImageExportBuilder.AsPng
- Method EmailImageExportBuilder.AsSvg
- Method EmailImageExportBuilder.AsTiff
- Method EmailImageExportBuilder.AsWebp
- Method EmailImageExportBuilder.AtDpi
- Method EmailImageExportBuilder.Continuous
- Method EmailImageExportBuilder.ForPreview
- Method EmailImageExportBuilder.ForPrint
- Method EmailImageExportBuilder.OnFileConflict
- Method EmailImageExportBuilder.OnRasterOverflow
- Method EmailImageExportBuilder.Paged
- Method EmailImageExportBuilder.WithBackground
- Method EmailImageExportBuilder.WithBackground
- Method EmailImageExportBuilder.WithFont
- Method EmailImageExportBuilder.WithFonts
- Method EmailImageExportBuilder.WithImageCodec
- Method EmailImageExportBuilder.WithMaximumRasterPixels
- Method EmailImageExportBuilder.WithPolicy
- Method EmailImageExportBuilder.WithProgress
- Method EmailImageExportBuilder.WithRasterEncoding
- Method EmailImageExportBuilder.WithScale
- Method EmailImageExportBuilder.WithTextShaping
- Method EmailImageExportBuilderExtensions.ToImage
Methods
public EmailImageExportBuilder Continuous() #Returns:
EmailImageExportBuilderUses one continuous image surface for the message.
public EmailImageExportBuilder Paged(Int32 pageIndex = 0) #Returns:
EmailImageExportBuilderUses paged layout and selects a zero-based rendered page.
Parameters
- pageIndex System.Int32 = 0
Inherited Methods
public EmailImageExportBuilder As(OfficeImageExportFormat format) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public EmailImageExportBuilder AsJpeg() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder AsPng() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder AsSvg() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder AsTiff() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder AsWebp() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder AtDpi(Double dpi) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
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 EmailImageExportBuilder ForPreview() #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EmailImageExportBuilder ForPrint(Double dpi = 300) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public EmailImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public EmailImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
EmailImageExportBuilderInherited 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 EmailImageExportBuilder WithBackground(OfficeColor color) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public EmailImageExportBuilder WithBackground(String color) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public EmailImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public EmailImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public EmailImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public EmailImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public EmailImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public EmailImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public EmailImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public EmailImageExportBuilder WithScale(Double scale) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public EmailImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
EmailImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null