File Element (DeploymentManifest - SPGenericObject)

Article
10/20/2016

Applies to: SharePoint Foundation 2010

Represents an instance of a Windows SharePoint Services 3.0 file (SPFile) object.

DECLARATION
<xs:element name="File" type="SPFile" />

USAGE
<SPObject>
        <File
                Name="xs:string"
                Id="Guid"
                Url="xs:string"
                ListItemIntId="xs:int"
                ParentWebId="Guid"
                ParentWebUrl="xs:string"
                ParentId="Guid"
                ListId="Guid"
                FileValue="xs:string"
                CheckinComment="xs:string"
                Version="xs:string"
                Author="xs:string"
                ModifiedBy="xs:string"
                TimeCreated="xs:dateTime"
                TimeLastModified="xs:dateTime"
                FailureMessage="xs:string"
                IsGhosted="xs:boolean"
                SetupPath="Guid"
                SetupPathUser="xs:string"
                SetupPathVersion="xs:byte"
            <Properties />
                        <Versions />
                        <WebParts />
                        <Personalizations />
                        <Links />
                        <EventReceivers />
        />
</SPObject>

Type

SPFile

Attributes

Attribute	Type	Description
Name	xs:string	Optional. Name of the file.
Id	Guid Simple Type (DeploymentManifest)	Unique identifier of the file. Optional on export; required by import.
Url	xs:string	The Web site-relative URL of the file. Optional on export; required by import.
ListItemIntId	xs:int	Optional. Integer identifier specifying the list item relative to position in a document library.
ParentWebId	Guid Simple Type (DeploymentManifest)	Unique identifier of parent Web site. Optional on export; required by import.
ParentWebUrl	xs:string	Optional. URL of the parent Web site.
ParentId	Guid Simple Type (DeploymentManifest)	Unique identifier of the parent folder for the file. Optional on export; required by import.
ListId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of the list in which the file exists. ListId values must match values for the Versions attribute.
FileValue	xs:string	Specifies the location of the file on disk. Optional on export; required by import for customized (unghosted) files and for document library items.
CheckinComment	xs:string	Optional. Comments provided when the file is checked in.
Versions	xs:string	Optional. Represents a collection of file version objects that specify file versions.
Author	xs:string	Optional. The user who created or uploaded the file.
ModifiedBy	xs:string	Optional. The user who last modified the file.
TimeCreated	xs:dateTime	Optional. Date-time value representing the time the file was created or uploaded.
TimeLastModified	xs:dateTime	Optional. Date-time value representing the tilme the file was last modified.
FailureMessage	xs:string	Optional. Message represented on failure at export or import.
IsGhosted	xs:boolean	Optional. Specifies whether the file exists on the front end (and not in the database), and therefore does not require a roundtrip to the database server.
SetupPath	xs:string	Path to the front-end file location in cases where the IsGhosted attribute is true. Optional on export; required by import if IsGhosted attribute is true.
SetupPathUser	xs:string	Optional. Person who initially created the list in the document library.
SetupPathVersion	xs:byte	Optional. Specifies the Windows Microsoft SharePoint Foundation Services version. The value 2 specifies Windows SharePoint Services 2.0; the value 3 specifies Windows SharePoint Services 3.0.