Class PageSavingArgs

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.3.0)

Provides data for the Aspose.Words.Saving.IPageSavingCallback.PageSaving(Aspose.Words.Saving.PageSavingArgs) event.

To learn more, visit the Programming with Documents documentation article.

public class PageSavingArgs

Inheritance

object ← PageSavingArgs

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

PageSavingArgs()

public PageSavingArgs()

Properties

KeepPageStreamOpen

Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.

public bool KeepPageStreamOpen { get; set; }

Property Value

bool

Remarks

Default is false and Aspose.Words will close the stream you provided in the Aspose.Words.Saving.PageSavingArgs.PageStream property after writing a document page into it. Specify true to keep the stream open.

PageFileName

Gets or sets the file name where the document page will be saved to.

public string PageFileName { get; set; }

Property Value

string

Remarks

If not specified then page file name and path will be generated automatically using original file name.

PageIndex

Current page index.

public int PageIndex { get; }

Property Value

int

PageStream

Allows to specify the stream where the document page will be saved to.

public Stream PageStream { get; set; }

Property Value

Stream

Remarks

This property allows you to save document pages to streams instead of files.

The default value is null. When this property is null, the document page will be saved to a file specified in the Aspose.Words.Saving.PageSavingArgs.PageFileName property.

If both Aspose.Words.Saving.PageSavingArgs.PageStream and Aspose.Words.Saving.PageSavingArgs.PageFileName are set, then PageStream will be used.