通过

SPFile 成员

  • 项目

表示可以是Web 部件页一个 SharePoint 网站中的文件、 文档库中的项或文件夹中的文件。

SPFile 类型公开以下成员。

属性

  名称 说明
公共属性 Author 获取文档上载到服务器，或在服务器上创建该文档的用户。
公共属性 BackwardLinks 获取表示向后链接的文件的链接对象的集合。
公共属性 CharSetName 获取文件中使用的字符集的名称。
公共属性 CheckedOutBy 已过时。此属性已过时。改为使用LockedByUser 。
公共属性 CheckedOutByUser 获取一个对象，表示已签出该文件的用户。
公共属性 CheckedOutDate 获取日期和时间，该文件已签出。
公共属性 CheckInComment 获取批注时使用文档签入文档库。
公共属性 CheckOutExpires 已过时。此属性已过时。改为使用LockExpires 。
公共属性 CheckOutStatus 已过时。此属性已过时。改为使用CheckOutType 。
公共属性 CheckOutType 获取一个值，该值指定如何将文件签出文档库。
公共属性 CustomizedPageStatus 获取的文件对象的自定义项 （也称为"幻影"） 状态。
公共属性 DocumentLibrary 获取父库的SPFile。
公共属性 EffectiveAuditMask 获取此对象的有效审核掩码。
公共属性 EffectiveRawPermissions 获取当前用户的有效基本权限。
公共属性 ETag 获取标识文件的一个版本 ETag。
公共属性 EventReceivers 获取事件接收器定义文件的集合。
公共属性 Exists 获取一个布尔值，该值指示该文件是否存在。
公共属性 ForwardLinks 获取表示文件中的正向链接的链接对象的集合。
公共属性 GeneratingConverterId 已过时。获取用于创建Guid.Empty的文件，如果该文件不是一个子文件的转换器的 ID。
公共属性 Generator 获取创建.htm 或.aspx 文件的应用程序的名称。
公共属性 IconUrl 获取与文件关联的图标的 URL。
公共属性 InDocumentLibrary 获取一个布尔值，该值指示文件是否属于到文档库。
公共属性 IsConvertedFile 已过时。获取一个布尔值，该值指示是否该文件对象被创建为一个文档转换的一部分。
公共属性 IsIRMed 获取一个布尔值，指示该文件是否已启用了信息权限管理。
公共属性 IsSharedAccessRequested 获取一个布尔值，该值指示文件是否已经请求的共享的访问。
公共属性 Item 获取对应于该文件，如果文件属于文档库的列表项对象。
公共属性 Length 获取或设置一个值，该值指定评估范围的起始编号。
公共属性 LengthByUser 获取包含有关每个用户的Web 部件页，其中包括用户名称、 用户 ID 和 Web 部件个性化设置占用的字节数信息的用户存储对象的集合。
公共属性 Level 获取文件的发布的级别。
公共属性 ListItemAllFields 获取与此文件，包括其所有字段值，如果该文件属于文档库对应的SPListItem对象。
公共属性 LockedByUser 获取已锁定该文件的用户。
公共属性 LockedDate 获取创建日期和时间的文件锁定。
公共属性 LockExpires 获取的过期日期和时间的文件锁定。
公共属性 LockId 在该文件上获取的当前锁定的标识符 (ID)。
公共属性 LockType 获取一个值，描述的是在一个文件的锁的类型。
公共属性 MajorVersion 获取该文件的主要版本。
公共属性 MinorVersion 获取文件的次要版本。
公共属性 ModifiedBy 获取一个表示最后一次修改文件的用户的用户对象。
公共属性 Name 获取包括扩展名在内的文件名称。
公共属性 ParentFolder 获取该文件的父文件夹。
公共属性 ProgID 获取一个字符串，标识在其中创建该文件的应用程序。
公共属性 Properties 获取元数据的文件。
公共属性 RequiresCheckout 获取一个Boolean值，指定该文件是否需要签出文档库中。
公共属性 ServerRedirected 获取一个布尔值，该值指示是否用户不能访问要查看源文件，或没有适当的客户端应用程序安装，用户被重定向到文件的服务器端呈现当用户单击一个链接以查看它。
公共属性 ServerRelativeUrl 基于服务器的 URL 获取文件的相对 URL。
公共属性 SourceFile 已过时。获取文档转换到已创建的文件的文件对象的父级。
公共属性 SourceLeafName 已过时。叶父文档的名称获取该文件。
公共属性 SourceUIVersion 已过时。获取的文件的父文档的版本号。
公共属性 TimeCreated 获取一个指示创建该文件时的日期和时间值。
公共属性 TimeLastModified 获取一个指示文件的上次修改日期和时间值。
公共属性 Title 获取的文件显示名称。
公共属性 TotalLength 获取文件的大小以字节为单位），包括任何在该文件中使用的 Web 部件的大小。
公共属性 UIVersion 获取该文件的版本号。
公共属性 UIVersionLabel 获取该文件的版本。
公共属性 UniqueId 获取唯一标识该文件中的内容数据库的 GUID。
公共属性 Url 获取文件相对于网站的 URL。
公共属性 Versions 获取表示该文件的版本的文件版本对象的集合。
公共属性 Web 获取网站文件的位置。

页首

方法

  名称 说明
公共方法 AddProperty 添加到列表中的该文件的元数据的项。
公共方法 Approve 批准已提交且需要使用指定注释进行内容审批的文件。
公共方法 CanOpenFile(Boolean) 指示当前用户是否有权查看的内容的文件，指定的访问级别。
公共方法 CanOpenFile(Boolean, String) 指示当前用户是否有权查看的内容的文件，指定访问级别以及输出变量来接收 ETag。
公共方法 CheckIn(String) 签入文档库具有指定备注的文件。
公共方法 CheckIn(String, SPCheckinType) 签入文档库基于指定的注释和签入的类型来执行文件。
公共方法 CheckOut() 签出文档库文件。
公共方法 CheckOut(Boolean, String) 通过指定是否要签出到本地计算机，并通过指定是否，文件不应该签出该文件已被修改某一日期之后将签出文档库中的文件。
公共方法 CheckOut(SPFile.SPCheckOutType, String) 签出指定文件不应为所需类型签出并通过指定在文档库中的文件签出是否它已被修改后的特定日期。
公共方法 Convert 已过时。转换的文件，使用指定的转换器。
公共方法 ConvertLock 将该文件上的现有锁转换为新类型的锁。
公共方法 CopyTo(String) 将该文件复制到目标 URL，而不会覆盖具有相同名称的现有文件。
公共方法 CopyTo(String, Boolean) 将该文件复制到目标 URL，还可以覆盖具有相同名称的现有文件。
公共方法 CreateSharedAccessRequest 请求共享该文件的访问权限。
公共方法 Delete 删除文件的对象。
公共方法 DeleteAllPersonalizations 从Web 部件页、 主页上或具有指定 ID 的 wiki 页面删除所有个性化设置信息
公共方法 DeleteAllPersonalizationsAllUsers 从Web 部件页中删除所有用户的个性化设置信息。
公共方法 DeleteCellStoragePartition 删除指定单元格存储分区中的所有条目。
公共方法 DeleteProperty 从元数据的文件的列表中删除的项。
公共方法 Deny 拒绝审批已提交供内容审批的文件。
公共方法 Equals （从 Object 继承。）
受保护的方法 Finalize （从 Object 继承。）
公共方法 GetConversionState 已过时。返回与指定的转换器 ID 文件的转换状态
公共方法 GetConvertedFile 已过时。返回从文档转换和指定的转换器使用此文件创建的子文件。
公共方法 GetHashCode （从 Object 继承。）
公共方法 GetHtmlTranslateCacheItem 从 HTML 转换，排除早于上次修改文件的日期的缓存项的缓存中返回该文件的内容。
公共方法 GetHtmlTranslateCacheNameFromStsName 从 HTML 转换缓存中返回的主文件的名称。
公共方法 GetLimitedWebPartManager 返回 Web 部件管理器与Web 部件页相关联。
公共方法 GetListItem 获取对应于此文件中， SPListItem ，如果此文件所属到文档库。此外为指定字段获取值。
公共方法 GetProperty 根据指定的键的文件，请从列表中的项的元数据中获取的值。
公共方法 GetType （从 Object 继承。）
公共方法 GetWebPartCollection 已过时。使用GetLimitedWebPartManager方法来返回一个SPLimitedWebPartManager对象，而是管理 Web 部件。（在Windows SharePoint Services 2.0的GetWebPartCollection方法返回关联的 Web 部件页的 Web 部件集合。
公共方法 Lock 创建锁文件，防止其他用户修改。
受保护的方法 MemberwiseClone （从 Object 继承。）
公共方法 MoveTo(String) 将文件移动到目标 URL，但不会覆盖具有相同名称的现有文件。
公共方法 MoveTo(String, SPMoveOperations) 将文件移动到指定的目标 URL 基于指定的操作的类型。
公共方法 MoveTo(String, Boolean) 将文件移动到目标 URL，还可以覆盖具有相同名称的现有文件。
公共方法 MoveTo(String, SPMoveOperations, Boolean) 将文件移动到指定的目标 URL。
公共方法 OpenBinary() 以二进制格式打开文件。
公共方法 OpenBinary(SPOpenBinaryOptions) 打开指定的文件作为字节数组，指定用于控制如何将打开的文件的选项。
公共方法 OpenBinaryStream() 打开作为数据流的文件。
公共方法 OpenBinaryStream(SPOpenBinaryOptions) 打开指定的文件以流的形式，并指定用于控制如何将打开的文件的选项。
公共方法 OpenBinaryStream(SPOpenBinaryOptions, String, String) 以流的形式根据指定的选项打开的文件。
公共方法 OpenBinaryStream(SPOpenBinaryOptions, String, SPFileRightsManagementSettings, String, String) 以流的形式打开该文件。
公共方法 OpenFileFormatMetaInfoStream 从数据库中获取此文件的文件格式的元信息。
公共方法 Publish 提交文件以使用指定的注释进行内容审批。
公共方法 Recycle 将该文件发送到回收站中。
公共方法 RefreshLock 续订现有的锁定的文件。
公共方法 ReleaseLock 释放由其标识符 (ID) 指定的现有锁定。
公共方法 RemoveSharedAccessRequest 将删除此文件的共享的访问请求中。
公共方法 ReplaceLink 指定链接的文件中的所有实例都替换为新的链接。
公共方法 RevertContentStream 返回到其原始状态，以使其逻辑成为在内存缓存中 （或"做幻像。"） 而不是存储在数据库中。
公共方法 SaveBinary([]) 基于指定的字节数组中的二进制格式保存文件。
公共方法 SaveBinary(Stream) 基于指定的流的二进制格式保存文件。
公共方法 SaveBinary([], Boolean) 基于指定的字节数组和一个布尔值，指定是否检查必填的字段的二进制格式保存文件。
公共方法 SaveBinary(Stream, SPFileSaveBinaryParameters) 基于流，其中包含文件和其他参数的SPFileSaveBinaryParameters对象的二进制格式保存文件。
公共方法 SaveBinary(Stream, Boolean) 根据指定的流和一个布尔值，指定是否检查必填的字段的二进制格式保存文件。
公共方法 SaveBinary(Stream, Boolean, Boolean, String, String, Stream, String) 保存该文件，并根据指定的流、 字符串和可选的ETag值文件格式的元数据。
公共方法 SaveBinary(Stream, Boolean, Boolean, String, String, Stream, Boolean, String) 保存该文件，并根据指定的流、 字符串、 布尔值和可选的ETag值文件格式的元数据。
公共方法 SaveFileFormatMetaInfoStream 保存包含指定数据库文件的文件格式信息的元数据的流。
公共方法 ScheduleEnd 设置在其的文件将被删除从公共文档库的视图的日期。
公共方法 ScheduleStart(DateTime) 计划在指定的日期和时间自动批准的需经审查的库中的文档。
公共方法 ScheduleStart(DateTime, Boolean) 安排在指定的日期和时间，自动批准的需经审查的库中的文档，并 （可选） 保持不变项的审核状态。
公共方法 ScheduleStart(DateTime, String) 计划在指定的日期和时间与指定说明以供审核的自动批准的需经审查的库中的文档。
公共方法 ScheduleStart(DateTime, Boolean, String) 计划在指定的日期和时间，带有指定的审批注释自动批准的需经审查的库中的文档，并 （可选） 更改列表项的审核状态。
公共方法 SendToOfficialFile(String) 将该文件发送到一个记录存储库中。
公共方法 SendToOfficialFile(String, String) 将该文件发送到一个记录存储库，并指定记录路由类型的名称。
公共方法 SendToOfficialFile(String, SPOfficialFileHost, String, SPOfficialFileSubmissionMode, String) 将文件发送到特定的 URL。
公共方法 SendToOfficialFile(String, SPOfficialFileHost, [], String, SPOfficialFileSubmissionMode, String) 将文件发送到特定的 URL。
公共方法静态成员 SendToOfficialFile(SPWeb, Uri, [], [], String, Uri, String, SPOfficialFileSubmissionMode, SPFile.CustomFileSubmissionPostProcessing, String) 将文件发送到目标路由器。
公共方法 SetHtmlTranslateCacheItem 该文件的内容保存到缓存中的 HTML 转换。
公共方法 SetProperty 设置元数据的文件的列表中的项的值。
公共方法静态成员 StorageManagementWebPartPageInformation 已过时。返回有关Web 部件页的存储管理信息。
公共方法 TakeOffline 使脱机文件的最新批准或主要版本。
公共方法 ToString 返回基于的网站或子网站的 URL 的文件的 URL。 （覆盖 Object.ToString()。）
公共方法 UndoCheckOut 撤消文件的签出。
公共方法 UnPublish 移除具有指定备注的文件中的内容审批。
公共方法 Update 与对文件所做的更改更新数据库。

页首

另请参阅

引用

SPFile 类

Microsoft.SharePoint 命名空间