OnWebFileCheckOut Event

Microsoft FrontPage Visual Basic

Show All Show All

OnWebFileCheckOut Event

Occurs when a file in the current Web site is checked out.

Private Sub expression_OnWebFileCheckOut(ByVal pWeb As Web, ByVal pFile As WebFile, CheckedOut As Boolean, pCheckOutOption As FpCheckOutOption)

expression     The variable name that references an object of type Application declared using the WithEvents keyword in a class module.

pWeb     The current WebEx object that contains the file.

pFile     The WebFile being checked out.

CheckedOut       A Boolean that indicates the status of the file. If True, the file is checked out. If False, the file has not been checked out.

pCheckOutoption FpCheckOutOption. Specifies the checkout file option.

FpCheckOutOption can be one of these FpCheckOutOption constants.
FPCheckOut Default. Check the file out.
FPCheckOutCancel Cancel the file check out.
FPCheckOutReadOnly Checks out a read-only version of the file.
FPCheckOutPromptUser Prompts the user before checking out the file.

Example

The following example prompts the user before the file is checked out.

    Private Sub objApp_OnWebFileCheckOut(ByVal pWeb As Web, ByVal pFile As WebFile,
                                     _ CheckedOut As Boolean, _
                                      pCheckOutOption As FpCheckOutOption)
'Occurs when a file in the current web is checked out.

    'Prompt the user before checking out the file
    pCheckOutOption = fpCheckOutPromptUser

End Sub