@@ -120,6 +120,11 @@ public ActionObject(PdfName type) {
120
120
/// ,
121
121
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
122
122
/// </remarks>
123
+ /// <returns>
124
+ ///
125
+ /// <see cref="iText.Kernel.Pdf.PdfName"/>
126
+ /// type of inner action element
127
+ /// </returns>
123
128
public virtual PdfName GetType ( ) {
124
129
return type ;
125
130
}
@@ -137,6 +142,15 @@ public virtual PdfName GetType() {
137
142
/// ,
138
143
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
139
144
/// </remarks>
145
+ /// <param name="type">
146
+ ///
147
+ /// <see cref="iText.Kernel.Pdf.PdfName"/>
148
+ /// type of inner action object
149
+ /// </param>
150
+ /// <returns>
151
+ /// current
152
+ /// <see cref="ActionObject"/>
153
+ /// </returns>
140
154
public virtual iText . Forms . Xfdf . ActionObject SetType ( PdfName type ) {
141
155
this . type = type ;
142
156
return this ;
@@ -147,15 +161,29 @@ public virtual iText.Forms.Xfdf.ActionObject SetType(PdfName type) {
147
161
/// Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
148
162
/// For more details see paragraph 6.5.30 in Xfdf specification.
149
163
/// </remarks>
164
+ /// <returns>
165
+ ///
166
+ /// <see cref="iText.Kernel.Pdf.PdfString"/>
167
+ /// value of URI element
168
+ /// </returns>
150
169
public virtual PdfString GetUri ( ) {
151
170
return uri ;
152
171
}
153
172
154
- /// <summary>Sets the string value of URI elements .</summary>
173
+ /// <summary>Sets the string value of URI element .</summary>
155
174
/// <remarks>
156
- /// Sets the string value of URI elements . Corresponds to Name, required attribute of URI element.
175
+ /// Sets the string value of URI element . Corresponds to Name, required attribute of URI element.
157
176
/// For more details see paragraph 6.5.30 in Xfdf specification.
158
177
/// </remarks>
178
+ /// <param name="uri">
179
+ ///
180
+ /// <see cref="iText.Kernel.Pdf.PdfString"/>
181
+ /// value to be set to URI element
182
+ /// </param>
183
+ /// <returns>
184
+ /// current
185
+ /// <see cref="ActionObject"/>
186
+ /// </returns>
159
187
public virtual iText . Forms . Xfdf . ActionObject SetUri ( PdfString uri ) {
160
188
this . uri = uri ;
161
189
return this ;
@@ -164,13 +192,19 @@ public virtual iText.Forms.Xfdf.ActionObject SetUri(PdfString uri) {
164
192
/// <summary>Gets IsMap, optional attribute of URI element.</summary>
165
193
/// <remarks>Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
166
194
/// </remarks>
195
+ /// <returns>boolean indicating if URI element is a map</returns>
167
196
public virtual bool IsMap ( ) {
168
197
return isMap ;
169
198
}
170
199
171
200
/// <summary>Sets IsMap, optional attribute of URI element.</summary>
172
201
/// <remarks>Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
173
202
/// </remarks>
203
+ /// <param name="map">boolean indicating if URI element is a map</param>
204
+ /// <returns>
205
+ /// current
206
+ /// <see cref="ActionObject"/>
207
+ /// </returns>
174
208
public virtual iText . Forms . Xfdf . ActionObject SetMap ( bool map ) {
175
209
isMap = map ;
176
210
return this ;
@@ -179,13 +213,27 @@ public virtual iText.Forms.Xfdf.ActionObject SetMap(bool map) {
179
213
/// <summary>Gets the value of Name, required attribute of Named element.</summary>
180
214
/// <remarks>Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
181
215
/// </remarks>
216
+ /// <returns>
217
+ ///
218
+ /// <see cref="iText.Kernel.Pdf.PdfName"/>
219
+ /// value of Name attribute of a named action element
220
+ /// </returns>
182
221
public virtual PdfName GetNameAction ( ) {
183
222
return nameAction ;
184
223
}
185
224
186
225
/// <summary>Sets the value of Name, required attribute of Named element.</summary>
187
226
/// <remarks>Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
188
227
/// </remarks>
228
+ /// <param name="nameAction">
229
+ ///
230
+ /// <see cref="iText.Kernel.Pdf.PdfName"/>
231
+ /// value to be set to Name attribute of a named action element
232
+ /// </param>
233
+ /// <returns>
234
+ /// current
235
+ /// <see cref="ActionObject"/>
236
+ /// </returns>
189
237
public virtual iText . Forms . Xfdf . ActionObject SetNameAction ( PdfName nameAction ) {
190
238
this . nameAction = nameAction ;
191
239
return this ;
@@ -198,6 +246,11 @@ public virtual iText.Forms.Xfdf.ActionObject SetNameAction(PdfName nameAction) {
198
246
/// Corresponds to F key in go-to action or launch dictionaries.
199
247
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
200
248
/// </remarks>
249
+ /// <returns>
250
+ ///
251
+ /// <see cref="System.String"/>
252
+ /// value of OriginalName attribute of current action object
253
+ /// </returns>
201
254
public virtual String GetFileOriginalName ( ) {
202
255
return fileOriginalName ;
203
256
}
@@ -209,21 +262,37 @@ public virtual String GetFileOriginalName() {
209
262
/// Corresponds to F key in go-to action or launch dictionaries.
210
263
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
211
264
/// </remarks>
265
+ /// <param name="fileOriginalName">
266
+ ///
267
+ /// <see cref="System.String"/>
268
+ /// value of OriginalName attribute of action object
269
+ /// </param>
270
+ /// <returns>
271
+ /// current
272
+ /// <see cref="ActionObject"/>
273
+ /// </returns>
212
274
public virtual iText . Forms . Xfdf . ActionObject SetFileOriginalName ( String fileOriginalName ) {
213
275
this . fileOriginalName = fileOriginalName ;
214
276
return this ;
215
277
}
216
278
217
- /// <summary>Sets the boolean value of NewWindow, optional attribute of Launch element.</summary>
218
- /// <remarks>Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
279
+ /// <summary>Gets the boolean value of NewWindow, optional attribute of Launch element.</summary>
280
+ /// <remarks>Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
219
281
/// </remarks>
282
+ /// <returns>boolean indicating if current Launch action element should be opened in a new window</returns>
220
283
public virtual bool IsNewWindow ( ) {
221
284
return isNewWindow ;
222
285
}
223
286
224
- /// <summary>Gets the boolean value of NewWindow, optional attribute of Launch element.</summary>
225
- /// <remarks>Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
287
+ /// <summary>Sets the boolean value of NewWindow, optional attribute of Launch element.</summary>
288
+ /// <remarks>Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
226
289
/// </remarks>
290
+ /// <param name="newWindow">boolean indicating if current Launch action element should be opened in a new window
291
+ /// </param>
292
+ /// <returns>
293
+ /// current
294
+ /// <see cref="ActionObject"/>
295
+ /// </returns>
227
296
public virtual iText . Forms . Xfdf . ActionObject SetNewWindow ( bool newWindow ) {
228
297
isNewWindow = newWindow ;
229
298
return this ;
@@ -235,6 +304,11 @@ public virtual iText.Forms.Xfdf.ActionObject SetNewWindow(bool newWindow) {
235
304
/// Corresponds to Dest key in link annotation dictionary.
236
305
/// For more details see paragraph 6.5.10 in Xfdf specification.
237
306
/// </remarks>
307
+ /// <returns>
308
+ ///
309
+ /// <see cref="DestObject"/>
310
+ /// destination attribute of current action element
311
+ /// </returns>
238
312
public virtual DestObject GetDestination ( ) {
239
313
return destination ;
240
314
}
@@ -245,6 +319,15 @@ public virtual DestObject GetDestination() {
245
319
/// Corresponds to Dest key in link annotation dictionary.
246
320
/// For more details see paragraph 6.5.10 in Xfdf specification.
247
321
/// </remarks>
322
+ /// <param name="destination">
323
+ ///
324
+ /// <see cref="DestObject"/>
325
+ /// destination attribute of the action element
326
+ /// </param>
327
+ /// <returns>
328
+ /// current
329
+ /// <see cref="ActionObject"/>
330
+ /// </returns>
248
331
public virtual iText . Forms . Xfdf . ActionObject SetDestination ( DestObject destination ) {
249
332
this . destination = destination ;
250
333
return this ;
0 commit comments