Document class
Syntax:
ref class PHOTOPAINT::Document;
Remarks:
The Document class defines the characteristics of a document object. In Corel PHOTO-PAINT, a document is either a single-page image or a multi-page collection of single-page images.
Properties:
Name Description
ActiveFrame Returns the reference to the currently active frame
ActiveLayer Returns the reference to the currently active layer
ActiveWindow Returns the reference to the currently active window
AllowImageMap Shows whether the image can have an image map assigned to it
Application Returns the application to which the object belongs
Background Returns the background object
Channels Returns a collection of the additional alpha channels
ColorTable Returns the color table object, if there is one
Dirty Returns or sets the modified state of the document
DpiX Returns or sets the horizontal resolution of the active image in dots per inch (dpi)
DpiY Returns or sets the vertical resolution of the active image in dots per inch (dpi)
FileName Returns the file name of the document
FilePath Returns the source path of the document
Frames Returns a collection of the existing frames
FullFileName Returns the full path name of the document
Grid Gets the grid
Guides Returns a collection of the existing guides
HasRollovers Shows whether the image has rollovers
HasSlices Shows whether the image has slices
IsMovie Returns a value indicating whether the active document is a movie
Layers Returns a collection of the document's layers
LockTransparency Returns or sets the locked state of the transparency
Mask Returns the mask object
Mode Returns the color mode of the active document
MovieFrameCount Returns the total number of movie frames within the document file
MovieStartFrame Returns the index of frame 1 within the document file
Name Returns or sets the name of the VBA project corresponding to the document
Parent Returns the application to which the object belongs
PDFSettings Gets PDF settings for the specified document
PrintSettings Gets Print Settings
RootGroup Returns the document's root group
Rulers Gets the rulers
SelectedGroups Returns all groups that are currently selected
SizeHeight Returns the height of the document in pixels
SizeWidth Returns the width of the document in pixels
Tools Returns a collection of available tools
VirtualHeight Returns or sets the virtual (relative) height of the document
VirtualWidth Returns or sets the virtual (relative) width of the document
Windows Returns a collection of the document's windows
Methods:
Name Description
Activate Activates the document
AddBackground Adds a background object if there was none
ApplyICCProfile Applies the specified ICC profile to the document
Checkpoint Stores the current state of the document
Clone Makes a temporary copy of the document
Close Closes the document
ConvertTo Converts the document to another color mode
ConvertToBW Converts the document to the black-and-white color mode
ConvertToDuotone Converts the document to the duotone mode
ConvertToMovie Converts the document into a movie
ConvertToNTSC Converts the color in a 24-bit RGB image to colors that are suitable for NTSC standard television reproduction
ConvertToPAL Converts the color in a 24-bit RGB image to colors that are suitable for PAL standard television reproduction
ConvertToPaletted Converts the document to the paletted color mode
ConvertToPaletted2 Converts the document to the paletted color mode
CreateGuide Creates a new guide
CreatePalette Creates a new palette
CreatePaletteFromVisible Creates a new palette from the visible layers
Crop Crops the current image to the specified rectangle
CropToColor Crops a specific color border surrounding an image to the point where a different colored pixel is encountered
CropToMask Crops the selected image to the bounding box of the current mask
DeskewCrop Crops an image. If the angle is set to a value other than 0, the image is also deskewed.
Duplicate Creates a copy of the image and gives it the specified name
Export Returns an ExportFilter object to export to a file
ExportForWeb Exports the document using the web settings
FindGroupByName Returns the group with the specified name
Flip Flips the image horizontally and/or vertically
Import Returns an ImportFilter object to import a file as a new set of layers
PaperSize Adjusts the size of the paper behind an image by using absolute width and height values. The image can be repositioned on the paper by setting a placement position.
PrintOut Prints the document
PublishToPDF Publishes the specified document to PDF
Redo Redoes a previously undone modification
Repeat Repeats the last modification made to the document
Resample Adjusts the dimensions and resolution of an image
RestoreCheckpoint Restores the document as it was at the last checkpoint
Revert Opens the last saved version of the document from disk
Rotate Rotates the image to a specified degree
Save Saves the document by using its current name and location
SaveAs Returns an ExportFilter object to save to a new file
SelectMovieFrames Selects a range of movie frames
SetResolution Sets the resolution of the active image in dots per inch (DPI)
Split Separates an image into the color channels corresponding to the specified color model
Undo Cancels the last modification made to the document
Version Information:
Corel PHOTO-PAINT: X7.4, X7, X7.6, X8, 2017, 2018, 2019, 2019.2, 2020, 2021, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3

© Corel Corporation. All rights reserved. The content herein is in the form of a personal web log ("Blog") or forum posting. As such, the views expressed in this site are those of the participants and do not necessarily reflect the views of Corel Corporation, or its affiliates and their respective officers, directors, employees and agents. Terms of Use / Privacy​ ​/ ​Cookies / Terms and Conditions / User Guidelines.