FileAttachment Complex Type

  • Article

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

The FileAttachment type contains the file attachment metadata and contents.

Syntax

<FileAttachment>
  <ID />
  <CreatedBy />
  <ModifiedBy />
  <Created />
  <Modified />
  <FullName />
  <Type />
  <Size />
  <Contents />
</FileAttachment>

Complex Type Elements

Element

Data type

Description

ID

xs:string

An ID that uniquely identifies the attachment file within the tool. Groove generates this ID when the attachment file is created. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation. Groove generates a new ID.

  • UpdateRecords operation: value ignored by operation. If the attachment content is included, Groove generates a new ID.

  • Events: value provided by events.

CreatedBy

xs:string

The Identity URL of the user who created the Forms tool attachment. Groove sets this field when the attachment file is created. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation. Groove sets this field based on the Identity URL in the GrooveHeader.

  • UpdateRecords operation: value ignored by operation. If the attachment content is included, Groove sets this field based on the Identity URL in the GrooveHeader.

  • Events: value provided by events.

ModifiedBy

xs:string

The Identity URL of the user who last modified the Forms tool attachment. Groove sets this field when the attachment file is created or modified. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation. Groove sets this field based on the Identity URL in the GrooveHeader.

  • UpdateRecords operation: value ignored by operation. If the attachment content is included, Groove sets this field based on the Identity URL in the GrooveHeader.

  • Events: value provided by events.

Created

xs:dateTime

The date-time that the attachment file was created. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation. Groove sets this field based the current time.

  • UpdateRecords operation: value ignored by operation. If the attachment content is included, Groove sets this field based on the current time.

  • Events: value provided by events.

Modified

xs:dateTime

The date and time that the attachment file was last modified. Groove sets this field based on the time that the attachment file was modified or created. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation. Groove sets this field based the current time.

  • UpdateRecords operation: value ignored by operation. If the attachment content is included, Groove sets this field based on the current time.

  • Events: value provided by events.

FullName

xs:string

The file name and extension. For example, "picture.jpg". This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value required by operation.

  • UpdateRecords operation: value required by operation.

  • Events: value provided by events.

Type

xs:string

A string that specifies whether the file attachment is a "File" or "Folder". Groove 2007 does not support folders in Forms tool attachments. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value required by operation. Value must be set to "File".

  • UpdateRecords operation: value required by operation. Value must be set to "File".

  • Events: value provided by events.

Size

xs:int

Size of the file attachment in bytes. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: value provided by operation.

  • CreateRecords operation: value ignored by operation.

  • UpdateRecords operation: value ignored by operation.

  • Events: value provided by events.

Contents

FileContents

Contents of the file attachment as a Base64 encoded value. This element is optional.

The usage of this element depends on the context:

  • QueryRecords and ReadRecords operations: if IncludeFileAttachmentContent parameter has a true value, value provided by operation. Otherwise Contents element is omitted.

  • CreateRecords operation: value required by operation.

  • UpdateRecords operation: if the Contents element is present, operation replaces all existing attachment files with the ones specified in this operation. If the Contents element is not included, all fields of the FileAttachment type are ignored.

  • Events: Content element is not provided by events.

See Also

Reference

GrooveForms2 Web Service

Forms2RecordDataSet Complex Type

FileContents Complex Type

Concepts

Accessing Forms Tool Records