API Reference
Class
OdpPresentation
Native OpenDocument Presentation document.
Inheritance
- OdfDocument
- OdpPresentation
Usage
Explore 4 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
- Method OdpPresentation.Create
- Method OdpPresentation.Load
- Method OdpPresentation.LoadAsync
- Method OdpPresentation.LoadFlatXml
Methods
public OdpPresentationLayout AddLayout(String name) #Returns:
OdpPresentationLayoutAdds an empty presentation layout.
Parameters
- name System.String
public OdpMasterPage AddMasterPage(String name) #Returns:
OdpMasterPageAdds an empty master page using the default page size.
Parameters
- name System.String
public OdpSlide AddSlide(String? name = null) #Returns:
OdpSlideAdds a slide using the default master and blank layout.
Parameters
- name System.String? = null
public static OdpPresentation Create() #Returns:
OdpPresentationCreates an empty ODF 1.4 presentation.
Load 2 overloads
public static OdpPresentation Load(String path, OdfLoadOptions? options = null) #Returns:
OdpPresentationLoads an ODP document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public static OdpPresentation Load(Stream stream, OdfLoadOptions? options = null) #Returns:
OdpPresentationLoads an ODP document from a stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
LoadAsync 2 overloads
public static async Task<OdpPresentation> LoadAsync(String path, OdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdpPresentation>Asynchronously loads an ODP document from a path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<OdpPresentation> LoadAsync(Stream stream, OdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdpPresentation>Asynchronously loads an ODP document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
LoadFlatXml 2 overloads
public static OdpPresentation LoadFlatXml(Stream stream, OdfLoadOptions? options = null) #Returns:
OdpPresentationLoads a flat OpenDocument Presentation XML stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public static OdpPresentation LoadFlatXml(String path, OdfLoadOptions? options = null) #Returns:
OdpPresentationLoads a flat OpenDocument Presentation XML path.
Parameters
- path System.String
- options OfficeIMO.OpenDocument.OdfLoadOptions? = null
public Void MoveSlide(Int32 sourceIndex, Int32 destinationIndex) #Returns:
VoidMoves a slide to a zero-based position.
Parameters
- sourceIndex System.Int32
- destinationIndex System.Int32
public Void RemoveSlide(Int32 index) #Returns:
VoidRemoves a slide by zero-based index.
Parameters
- index System.Int32
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public IReadOnlyList<OfficeEmbeddedPayloadInfo> GetEmbeddedPayloads(OfficeEmbeddedPayloadInspectionOptions options, CancellationToken cancellationToken = default) #Returns:
IReadOnlyList<OfficeEmbeddedPayloadInfo>Inherited from OdfDocument
Parameters
- options OfficeEmbeddedPayloadInspectionOptions
- cancellationToken CancellationToken = default
public Int64 GetPackageEntryByteLength(String reference) #Returns:
Int64Inherited from OdfDocument
Parameters
- reference String
GetPackageEntryBytes 2 overloads
public Byte[] GetPackageEntryBytes(String path) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- path String
public Byte[] GetPackageEntryBytes(String path, Int64 maximumBytes) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- path String
- maximumBytes Int64
public String? GetPackageEntryMediaType(String reference) #Returns:
String?Inherited from OdfDocument
Parameters
- reference String
public OdfPackageEntryPayloadState GetPackageEntryPayloadState(String reference) #Returns:
OdfPackageEntryPayloadStateInherited from OdfDocument
Parameters
- reference String
public OfficeEmbeddedPayloadInspection InspectEmbeddedPayloads(OfficeEmbeddedPayloadInspectionOptions? options = null, CancellationToken cancellationToken = default) #Returns:
OfficeEmbeddedPayloadInspectionInherited from OdfDocument
Parameters
- options OfficeEmbeddedPayloadInspectionOptions? = null
- cancellationToken CancellationToken = default
InspectFeatures 2 overloads
public OdfFeatureReport InspectFeatures(CancellationToken cancellationToken) #Returns:
OdfFeatureReportInherited from OdfDocument
Parameters
- cancellationToken CancellationToken
public OfficeContentSafetyReport InspectLoadedContentSafety(OfficeContentSafetyOptions? options = null, CancellationToken cancellationToken = default) #Returns:
OfficeContentSafetyReportInherited from OdfDocument
Parameters
- options OfficeContentSafetyOptions? = null
- cancellationToken CancellationToken = default
public Stream OpenEmbeddedPayload(String id, Int64 maximumBytes, CancellationToken cancellationToken = default) #Returns:
StreamInherited from OdfDocument
Parameters
- id String
- maximumBytes Int64
- cancellationToken CancellationToken = default
Save 3 overloads
public OdfSaveResult Save(OdfSaveOptions? options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- options OdfSaveOptions? = null
public OdfSaveResult Save(String path, OdfSaveOptions? options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
public OdfSaveResult Save(Stream destination, OdfSaveOptions? options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- destination Stream
- options OdfSaveOptions? = null
SaveAsync 4 overloads
public Task<OdfSaveResult> SaveAsync(CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- cancellationToken CancellationToken = default
public Task<OdfSaveResult> SaveAsync(OdfSaveOptions? options, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- options OdfSaveOptions?
- cancellationToken CancellationToken = default
public async Task<OdfSaveResult> SaveAsync(String path, OdfSaveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
public async Task<OdfSaveResult> SaveAsync(Stream destination, OdfSaveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- destination Stream
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
public OdfSaveResult SaveCopy(String path, OdfSaveOptions? options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
public async Task<OdfSaveResult> SaveCopyAsync(String path, OdfSaveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<OdfSaveResult>Inherited from OdfDocument
Parameters
- path String
- options OdfSaveOptions? = null
- cancellationToken CancellationToken = default
SaveFlatXml 2 overloads
public OdfSaveResult SaveFlatXml(Stream destination) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- destination Stream
public OdfSaveResult SaveFlatXml(String path) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- path String
public OdfSaveResult Serialize(OdfSaveOptions? options = null) #Returns:
OdfSaveResultInherited from OdfDocument
Parameters
- options OdfSaveOptions? = null
public Byte[] ToBytes(OdfSaveOptions? options = null) #Returns:
Byte[]Inherited from OdfDocument
Parameters
- options OdfSaveOptions? = null
public MemoryStream ToStream(OdfSaveOptions? options = null) #Returns:
MemoryStreamInherited from OdfDocument
Parameters
- options OdfSaveOptions? = null
Properties
public IReadOnlyList<OdpMasterPage> MasterPages { get; } #Master pages stored in styles.xml.
public IReadOnlyList<OdpPresentationLayout> Layouts { get; } #Presentation page layouts stored in styles.xml.
public OdfLength PageWidth { get; set; } #Width of the default presentation page.
public OdfLength PageHeight { get; set; } #Height of the default presentation page.
Inherited Properties
public IReadOnlyList<OdfDiagnostic> Diagnostics { get; } #Inherited from OdfDocument
public IReadOnlyList<String> PackageEntries { get; } #Inherited from OdfDocument
public IReadOnlyList<String> BinaryPayloadEntries { get; } #Inherited from OdfDocument