Groupwise Developer's Guide

More documents

Recommendations

Info

Document.Add(Filename as String,[DocumentType as Variant]) Document.AddEx(Filename as String,[DocumentType as Variant],[DocRefFolder as Folder]) Parameter Data Type Description Filename String This is the full path and name of the file on disk that you want to use to create the new document. DocumentType Variant This parameter may be either a string that is the name of the DocumentType for the document, or it may be the actual Document- Type object. The DocumentType object is discussed briefly below in the ** section. DocRefFolder Folder object This is a Folder object containing the folder in which to place the new document reference for the document 108 Both Add() and AddEx() return a Document reference for the newly created document. From there, you can set the other Document properties. AddEx() adds the document reference in DocRefFolder, whild Add() does not create a document reference in any folder. The following procedure will add the c:\config.sys file to the GroupWise library, and create a reference in the mailbox. Example in VB: 'gwAccount is a valid Account object Dim gwDocument As GroupwareTypeLibrary.Document Private Sub AddDocument() Set gwDocument = gwAccount.DefaultDocumentLibrary.Documents.AddEx(“c:config.sys”,,gwAccount.Mailb ox) Msgbox “New Document Number: ” & cStr(gwDocument.DocumentNumber) End Sub Example in Delphi: //gwAccount is a valid Account object procedure AddDocument; var gwDocument:variant; begin gwDocument:=gwAccount.DefaultDocumentLibrary.Documents.AddEx('c:\config.sys', {leave second parameter blank for default},gwAccount.Mailbox); ShowMessage('New Document Number: ' + inttostr(gwDocument.DocumentNumber)); end; www.novell.com/appnotes
The Document and DocumentVersions Objects The Document object is a collection of DocumentVersion objects, plus some additional information. Each version of each file in the GroupWise library has an associated DocumentVersion. You cannot access and file in the library unless you access that files DocumentVersion. The easiest way to access your DocumentVersion of choice is to access the DocumentReference.DocumentVersion property. This becomes problematic, however, when the DocumentReference.RefType is egwCurrent, yet you want a specific version, or vice versa. To access the current version of a document, you can access DocumentReference.Document.CurrentVersion property. If you need to access all document versions in order to select one, access the Document.DocumentVersions object. The Document Object The Document object encapsulates all versions of a given document. It has several important properties: Property Data Type Description Subject String This string holds the subject description of the document. AdditionalRights DocumentAccess Rights object This collection contains information about the sharing rights of the document for the particular account that is logged into the Object API. Author Address object This is an Address object containing the address information for the author of this document. AuthorCreateRights DocumentAccessRights object (R/O) Access rights granted to the document’s author. If running GroupWise Remote, this property is empty. CreationDate Date This is a date property containing the creation date of the document. Creator Address object (R/O) This is an Address object containing the address information for the creator of this document. CurrentVersion DocumentVersion object (R/O) This is the current version of the document in the form of a DocumentVersion object. DefaultRights DocumentAccess Rights object (R/O) This collection contains the sharing rights granted to everyone. DocumentLibrary DocumentLibrary object (R/O) The library that contains the document C h a p t e r 6 109
Page 1 and 2:
GroupWise® developer’s guide Nov
Page 3 and 4:
Dear Readers: Introduction Welcome
Page 5 and 6:
Chapter 13: (not yet available) Cha
Page 7 and 8:
Getting Started with the Object API
Page 9 and 10:
COM can be a complicated subject to
Page 11 and 12:
Late Binding The GroupWise Object A
Page 13 and 14:
Reasons For Using Type Libraries. S
Page 15 and 16:
Figure 4: Look up the syntax of the
Page 17 and 18:
Setting up C++ In C++, the normal w
Page 19 and 20:
Logging in Once you have gotten a r
Page 21 and 22:
} vWhenToPrompt, vReserved, &pDIGWA
Page 23 and 24:
If JoeUser has multiple accounts -
Page 25 and 26:
End If Set gwAccount = Nothing Set
Page 27 and 28:
The problem is that the GroupWise O
Page 29 and 30:
AccountRights Property One of the i
Page 31 and 32:
ProxyAccounts and Proxied Propertie
Page 33 and 34:
Archive Properties Non-Collection T
Page 35 and 36:
Here is a Visual Basic example that
Page 37 and 38:
Summary SynchronizeWithMaster (flag
Page 39 and 40:
Folders Folders, like many other co
Page 41 and 42:
Exit Sub FldrErr: MsgBox "Folder no
Page 43 and 44:
• Account.WorkFolder: Returns the
Page 45 and 46:
System Creating a Folder These are
Page 47 and 48:
Example in VB: 'gwAccount is a vali
Page 49 and 50:
Example in Delphi: //gwAccount is a
Page 51 and 52:
Testing a Folder For Folder Rights
Page 53 and 54:
Example in Delphi: //gwAccount is a
Page 55 and 56:
Example in VB: 'gwAccount is a vali
Page 57 and 58:
Removing User Access to a Shared Fo
Page 59 and 60: This method empties the trash folde
Page 61 and 62: gwTestMessage1:=gwFoundTrashItems.I
Page 63 and 64: The Messages Collection The Message
Page 65 and 66: procedure FindMessagesWithThe2; var
Page 67 and 68: Messages.Add() You can create eithe
Page 69 and 70: When linking messages, you pass the
Page 71 and 72: Set GW = CreateObject("NovellGroupW
Page 73 and 74: Name Description Skip(NumMessages)
Page 75 and 76: Item() takes as single parameter ca
Page 77 and 78: Understanding Message and Message R
Page 79 and 80: Property Data Type Description Encl
Page 81 and 82: MessageSubtype.Reply([ClassName as
Page 83 and 84: Mail The Mail object represents a G
Page 85 and 86: Although this method requires no pa
Page 87 and 88: PhoneMessage The PhoneMessage objec
Page 89 and 90: Setting and Accessing the Propertie
Page 91 and 92: gwAccount.Refresh; {refresh the dat
Page 93 and 94: Example in VB: 'gwAccount is a vali
Page 95 and 96: Example in VB: 'gwMail is a valid M
Page 97 and 98: Adding Recipients Four different Ad
Page 99 and 100: Summary In this chapter you learned
Page 101 and 102: Document References The DocumentRef
Page 103 and 104: if gwAttachment.ObjType =egwFile th
Page 105 and 106: Name Data Type Description Starting
Page 107 and 108: DocNumber is an integer that contai
Page 109: Dim gwDocIterator As GroupwareTypeL
Page 113 and 114: The DocumentVersions Object The Doc
Page 115 and 116: The Retrieve() method will generate
Page 117 and 118: Document Rights The DocumentAccessR
Page 119 and 120: The DocumentType Object The key pro
Page 121 and 122: Manipulating Addresses and Address
Page 123 and 124: If it can find a match, it is consi
Page 125 and 126: Property Type Members GroupMembers
Page 127 and 128: You may also obtain an AddressBook
Page 129 and 130: Summary 127 In this chapter you lea
Page 131 and 132: Pre-defined and Custom Field Object
Page 133 and 134: 130 Adding a FieldDefinition to a c
Page 135 and 136: 132 Example in Delphi: //gwAccount
Page 137 and 138: 134 Example in VB: Set gwProjectIDF
Page 139 and 140: 136 Each column represents a proper
Page 141 and 142: 138 Personal AddressBook objects ca
Page 143 and 144: 140 Figure 4: The Microsoft PAB. Th
Page 145 and 146: 142 It’s quite a different list!
Page 147 and 148: 144 Suppose you have a DocumentLibr
Page 149 and 150: 146 Example in Delphi: //gwDocument
Page 151 and 152: 148 Figure 13: Lookup table list. I
Page 153 and 154: 150 Figure 15: Lookup. FieldDefinit
Page 155 and 156: Related Properties 152 The LookupTa
Page 157 and 158: 154 Figure 18: Values in the Case I
Page 159 and 160: Summary 156 The ultimate value that
Page 161 and 162:
Filters The Filter Object 158 Like
Page 163 and 164:
160 The properties we are intereste
Page 165 and 166:
Parameter Data Type Description Loc
Page 167 and 168:
164 The following syntax returns ob
Page 169 and 170:
166 The following examples should h
Page 171 and 172:
Summary 168 Basic Expressions Use t
Page 173 and 174:
170 • IconFactory These files may
Page 175 and 176:
172 EventMonitor The EventMonitor o
Page 177 and 178:
Registration 174 Execute Following
Page 179 and 180:
176 Incorrect "C:\WINDOWS\Desktop\s
Page 181 and 182:
178 sAppName := 'Help Desk'; Reg :=
Page 183 and 184:
Customizing Main Menus Customizing
Page 185 and 186:
egin If CompareStr(Context, 'GW.CLI
Page 187 and 188:
The GWMenuAction Object The GWMenuA
Page 189 and 190:
vMenu : variant; vSeparator: varian
Page 191 and 192:
Let’s now take a look at actually
Page 193 and 194:
Return Value It is important to not
Page 195 and 196:
Figure 2: Choose context to modify
Page 197 and 198:
5. The example above will add a men
Page 199 and 200:
The following code adds a “Sample
Page 201 and 202:
Figure 9: C3PO Creation Wizard. 1.
Page 203 and 204:
Figure 13: 5. Continue to add menus
Page 205 and 206:
The GWToolBar.ToolbarItems Property
Page 207 and 208:
'C3PO WIZARD icons.dll can be repla
Page 209 and 210:
Power Tip: ToolbarID You can manipu
Page 211 and 212:
Figure 17: Context to modify toolba
Page 213 and 214:
Summary Figure 20: Finishind the C3
Page 215 and 216:
212 GroupWise calls WantCommand() w
Page 217 and 218:
214 Figure 4: Finishing C3PO Creati
Page 219 and 220:
216 • Alternatively, the Compose
Page 221 and 222:
GroupWise Events 218 Figure 7: Fini
Page 223 and 224:
end; 220 else if CompareText(evt.Pe
Page 225 and 226:
Summary 222 Figure 11: Finishing C3
Page 227 and 228:
224 More About the Button Bar The v
Page 229 and 230:
end; 226 end; if messageid'X00' the
Page 231 and 232:
228 Use The Wizard Our first task i
Page 233 and 234:
The C3PO Server 230 Font.Color = cl
Page 235 and 236:
232 Delphi Example procedure Regist
Page 237 and 238:
234 Adding the Menu Now we will add
Page 239 and 240:
The Form Functions 236 This seems l
Page 241 and 242:
Summary 238 This procedure is doing
show all

Groupwise Developer's Guide

Create successful ePaper yourself

Delete template?

Save as template?