DSOFramer Interface Definition

 

DSOFramer Interface Definition

General Information
Library: DSOFramer (DSO ActiveX Document Framer Control)
File: G:\Study_Document\ÎÒµÄ×ÊÁÏ¿â\weboffice\oframer\dsoframer.ocx
GUID: {06889570-8875-4B79-8BC9-18E96A143E82}
Version: 2.3

Enumerations
This section lists enumerations exposed by DSOFramer.

Public Enum dsoBorderStyle
 dsoBorderNone=0
 dsoBorderFlat=1
 dsoBorder3D=2
 dsoBorder3DThin=3
End Enum
Public Enum dsoFileCommandType
 dsoFileNew=0
 dsoFileOpen=1
 dsoFileClose=2
 dsoFileSave=3
 dsoFileSaveAs=4
 dsoFilePrint=5
 dsoFilePageSetup=6
 dsoFileProperties=7
 dsoFilePrintPreview=8
End Enum
Public Enum dsoShowDialogType
 dsoDialogNew=0
 dsoDialogOpen=1
 dsoDialogSave=2
 dsoDialogSaveCopy=3
 dsoDialogPrint=4
 dsoDialogPageSetup=5
 dsoDialogProperties=6
End Enum

Interfaces
This section lists the Classes exposed by DSOFramer.  For each class, the methods and events are listed.

_DFramerCtlEvents {06889575-8875-4B79-8BC9-18E96A143E82}

Methods
Function OnFileCommand(ByVal Is dsoFileCommandType, ByVal Cancel As Boolean) As ???
Called when File menu item is selected by user (may be canceled).
Function OnDocumentOpened(ByVal File As String, ByVal Document As Object) As ???
Called when document is opened or new document added.
Function OnDocumentClosed() As ???
Called when document is closed.
Function OnActivationChange(ByVal fGoingActive As Boolean) As ???
Called when component gains/loses activation.
Function BeforeDocumentClosed(ByVal Document As Object, ByVal Cancel As Boolean) As ???
Called before document is closed (may be canceled).
Function BeforeDocumentSaved(ByVal Document As Object, ByVal Location As String, ByVal Cancel As Boolean) As ???
Called before document is saved (may be canceled).
Function OnPrintPreviewExit() As ???
Called when print preview is closed.
Function NotifyCtrlReady() As ???
Ctrl Ready
Events
None

FramerControl {06889572-8875-4B79-8BC9-18E96A143E82}

Methods
Sub Activate
Activates the current document object.
Property Get ActiveDocument() As Object
Returns the Automation interface of the document object.
Sub CreateNew(ByVal ProgIdOrTemplate As String)
Creates a new document based on the ProgId or Template file provided.
Sub Open(ByVal Document As Variant, Optional ByVal ReadOnly As Variant, Optional ByVal ProgId As Variant, Optional ByVal WebUsername As Variant, Optional ByVal WebPassword As Variant)
Opens a document from a file, URL, or Automation object.
Sub Save(Optional ByVal SaveAsDocument As Variant, Optional ByVal OverwriteExisting As Variant, Optional ByVal WebUsername As Variant, Optional ByVal WebPassword As Variant)
Saves the document to specified location or its original location.
Sub Close
Closes the currently open document.
Property Let Caption(RHS  As String)
Returns/sets the titlebar caption.
Property Get Caption() As String
Returns/sets the titlebar caption.
Property Let Titlebar(RHS  As Boolean)
Returns/sets whether the titlebar should be displayed.
Property Get Titlebar() As Boolean
Returns/sets whether the titlebar should be displayed.
Property Let Toolbars(RHS  As Boolean)
Returns/sets whether toolbars should be displayed.
Property Get Toolbars() As Boolean
Returns/sets whether toolbars should be displayed.
Sub ShowDialog(ByVal DlgType As dsoShowDialogType)
Displays a modal dialog of the given type for user action.
Property Let EnableFileCommand(ByVal Item As dsoFileCommandType, RHS As Boolean)
Returns/sets whether a specific action item is enabled.
Property Get EnableFileCommand(ByVal Item As dsoFileCommandType) As Boolean
Returns/sets whether a specific action item is enabled.
Property Let BorderStyle(RHS  As dsoBorderStyle)
Returns/sets the border style for the control.
Property Get BorderStyle() As dsoBorderStyle
Returns/sets the border style for the control.
Property Let BorderColor(RHS  As ULong)
Returns/sets the border color of the control.
Property Get BorderColor() As ULong
Returns/sets the border color of the control.
Property Let BackColor(RHS  As ULong)
Returns/sets the background color of the control.
Property Get BackColor() As ULong
Returns/sets the background color of the control.
Property Let ForeColor(RHS  As ULong)
Returns/sets the foreground color of the control.
Property Get ForeColor() As ULong
Returns/sets the foreground color of the control.
Property Let TitlebarColor(RHS  As ULong)
Returns/sets the color of the titlebar.
Property Get TitlebarColor() As ULong
Returns/sets the color of the titlebar.
Property Let TitlebarTextColor(RHS  As ULong)
Returns/sets the color of text for the titlebar.
Property Get TitlebarTextColor() As ULong
Returns/sets the color of text for the titlebar.
Sub ExecOleCommand(ByVal OLECMDID As Long, Optional ByVal Options As Variant, Optional ByVal vInParam As Variant, Optional ByVal vInOutParam As Variant)
Calls IOleCommandTarget::Exec on embedded object.
Property Let Menubar(RHS  As Boolean)
Returns/sets whether a menu bar should be displayed.
Property Get Menubar() As Boolean
Returns/sets whether a menu bar should be displayed.
Property Let HostName(RHS  As String)
Returns/sets host application name (used in embedding).
Property Get HostName() As String
Returns/sets host application name (used in embedding).
Property Get DocumentFullName() As String
Returns full document path name for object.
Sub PrintOut(Optional ByVal PromptUser As Variant, Optional ByVal PrinterName As Variant, Optional ByVal Copies As Variant, Optional ByVal FromPage As Variant, Optional ByVal ToPage As Variant, Optional ByVal OutputFile As Variant)
Prints current document to specific printer with settings.
Sub PrintPreview
Starts a print preview (if document supports it).
Sub PrintPreviewExit
Exits a current print preview.
Property Get IsReadOnly() As Boolean
Returns True/False if file was open read-only, or has not been saved.
Property Get IsDirty() As Boolean
Returns True/False if file has been altered or needs save.
Function HttpInit() As Boolean
Init the Http Engine. First
Function HttpAddPostString(ByVal strName As String, ByVal strValue As String) As Boolean
Add Post Data
Function HttpPost(ByVal bstr As String) As String
Post the data to the URL(bstr). End
Function SetTrackRevisions(ByVal vbool As Long) As Boolean
Set the document to TrackRevisions state
Function SetCurrUserName(ByVal strCurrUserName As String) As Boolean
Set Curr User
Function HttpAddPostCurrFile(ByVal strFileID As String, ByVal strFileName As String) As Boolean
Add Post Data
Function SetCurrTime(ByVal strValue As String) As Boolean
Set Curr Time ; Linke 2006:02:07 11:11:11
Property Get GetApplication() As Object
Get the application dispatch
Function SetFieldValue(ByVal strFieldName As String, ByVal strValue As String, ByVal strCmdOrSheetName As String) As Boolean
Set Field Or sheetValue
Function GetFieldValue(ByVal strFieldName As String, ByVal strCmdOrSheetName As String) As String
Get Field Or sheetValue
Function SetMenuDisplay(ByVal lMenuFlag As Long) As Boolean
Set Menu Enable
Function ProtectDoc(ByVal lProOrUn As Long, ByVal lProType As Long, ByVal strProPWD As String) As Boolean
ProtectDoc
Function ShowRevisions(ByVal nNewValue As Long) As Boolean
ShowRevisions
Function InSertFile(ByVal strFieldPath As String, ByVal lPos As Long) As Boolean
Set Field Or sheetValue
Function LoadOriginalFile(ByVal strFieldPath As Variant, ByVal strFileType As Variant) As Long
Load File
Function SaveAs(ByVal strFileName As Variant, ByVal dwFileFormat As Variant) As Long
Save As
Sub DeleteLocalFile(ByVal strFilePath As String)
DeleteLocalFile
Function GetTempFilePath() As String
GetTempFilePath
Function ShowView(ByVal dwViewType As Long) As Long
ShowView
Function FtpConnect(ByVal strURL As String, ByVal lPort As Long, ByVal strUser As String, ByVal strPwd As String) As Long
FtpConnect
Function FtpGetFile(ByVal strRemoteFile As String, ByVal strLocalFile As String) As Long
FtpGetFile
Function FtpPutFile(ByVal strLocalFile As String, ByVal strRemoteFile As String, ByVal blOverWrite As Long) As Long
FtpPutFile
Function FtpDisConnect() As Long
FtpDisConnect
Function DownloadFile(ByVal strRemoteFile As String, ByVal strLocalFile As String) As String
Download File
Function HttpAddPostFile(ByVal strFileID As String, ByVal strFileName As String) As Long
Add Post File
Function GetRevCount() As Long
Get Rev Index
Function GetRevInfo(ByVal lIndex As Long, ByVal lType As Long) As String
Get Rev Index Info
Function SetValue(ByVal strValue As String, ByVal strName As String) As Long
Set Doc Prop
Function SetDocVariable(ByVal strVarName As String, ByVal strValue As String, ByVal lOpt As Long) As Long
Set Doc Variable
Function SetPageAs(ByVal strLocalFile As String, ByVal lPageNum As Long, ByVal lType As Long) As Long
Save page To Doc
Function ReplaceText(ByVal strSearchText As String, ByVal strReplaceText As String, ByVal lGradation As Long) As Long
Replace Text
Function GetEnvironmentVariable(ByVal EnvironmentName As String) As String
Get EnvironmentVariable
Function GetOfficeVersion(ByVal strName As String) As String
Get Office Version
Events
None