public class ScreenCapture
ScreenCapture
Screen Capture Class
Modifier and Type | Method and Description |
---|---|
static BBjString | capture() Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog |
static BBjString | capture(BBjString p_filepath$) Method capture: Capture entire screen directly to the given client file path, without the file save dialog |
static BBjString | capture(BBjString p_filepath$, BBjNumber p_show) Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog |
static BBjString | capture(BBjNumber p_useClient) Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog |
static BBjString | capture(BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) Method capture: Capture entire screen to the given file path, optionally showing the file save dialog |
static BBjString | capture(BBjWindow p_win!) Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog |
static BBjString | capture(BBjWindow p_win!, BBjString p_filepath$) Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog |
static BBjString | capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show) Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog |
static BBjString | capture(BBjWindow p_win!, BBjNumber p_useClient) Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog |
static BBjString | capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog |
static BBjString | capture(BBjMDI p_mdi!) Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog |
static BBjString | capture(BBjMDI p_mdi!, BBjString p_filepath$) Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog |
static BBjString | capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show) Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog |
static BBjString | capture(BBjMDI p_mdi!, BBjNumber p_useClient) Method capture: Capture a MDI, defaulting the file path, without showing the save dialog |
static BBjString | capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog |
static BBjImage | getScreenImage() Method getScreenImage: Capture an image of the entire screen |
static BBjString | getTempDir() Method getTempDir: Get temporary directory path |
static BBjString | getTempDir(BBjNumber p_useClient) Method getTempDir: Get temporary directory path on server or client |
static BBjString | saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show) Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog |
static BBjString | saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient) Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog |
public static BBjString capture()
Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog
public static BBjString capture(BBjString p_filepath$)
Method capture: Capture entire screen directly to the given client file path, without the file save dialog
BBjString
Optional path to client file in which the image is savedDefaults to file beginning with "scrncap_" in the default temporary directory
public static BBjString capture(BBjString p_filepath$, BBjNumber p_show)
Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog
BBjString
Optional path to client file in which the image is savedDefaults to file beginning with "scrncap_" in the default temporary directory
BBjNumber
Boolean flag whether save dialog should be displayedpublic static BBjString capture(BBjNumber p_useClient)
Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog
BBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjString capture(BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)
Method capture: Capture entire screen to the given file path, optionally showing the file save dialog
BBjString
Optional path to file in which the image is savedDefaults to file beginning with "scrncap_" in the default temporary directory
BBjNumber
Boolean flag whether save dialog should be displayedBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjString capture(BBjWindow p_win!)
Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog
BBjWindow
Top-level or child window objectpublic static BBjString capture(BBjWindow p_win!, BBjString p_filepath$)
Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog
BBjWindow
Top-level or child window objectBBjString
Optional path to file in which the image is savedpublic static BBjString capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show)
Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog
BBjWindow
Top-level or child window objectBBjString
Optional path to file in which the image is savedBBjNumber
Boolean flag whether save dialog should be displayedpublic static BBjString capture(BBjWindow p_win!, BBjNumber p_useClient)
Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog
BBjWindow
Top-level or child window objectBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjString capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)
Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog
BBjWindow
Top-level or child window objectBBjString
Optional path to file in which the image is savedBBjNumber
Boolean flag whether save dialog should be displayedBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjString capture(BBjMDI p_mdi!)
Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog
BBjMDI
MDI objectpublic static BBjString capture(BBjMDI p_mdi!, BBjString p_filepath$)
Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog
BBjMDI
MDI objectBBjString
Optional path to file in which the image is savedpublic static BBjString capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show)
Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog
BBjMDI
MDI objectBBjString
Optional path to file in which the image is savedBBjNumber
Boolean flag whether save dialog should be displayedpublic static BBjString capture(BBjMDI p_mdi!, BBjNumber p_useClient)
Method capture: Capture a MDI, defaulting the file path, without showing the save dialog
BBjMDI
MDI objectBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjString capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)
Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog
BBjMDI
MDI objectBBjString
Optional path to file in which the image is savedBBjNumber
Boolean flag whether save dialog should be displayedBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUIpublic static BBjImage getScreenImage()
Method getScreenImage: Capture an image of the entire screen
public static BBjString getTempDir()
Method getTempDir: Get temporary directory path
public static BBjString getTempDir(BBjNumber p_useClient)
Method getTempDir: Get temporary directory path on server or client
BBjNumber
Boolean flag whether client environment should be usedpublic static BBjString saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show)
Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog
BBjImage
Captured imageBBjString
Optional path to client file in which the image is savedDefaults to file beginning with "scrncap_" in the default temporary directory
BBjNumber
Boolean flag whether save dialog should be displayedpublic static BBjString saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)
Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog
BBjImage
Captured imageBBjString
Optional path to file in which the image is savedDefaults to file beginning with "scrncap_" in the default temporary directory
BBjNumber
Boolean flag whether save dialog should be displayedBBjNumber
Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI