PFFile Methods |
The PFFile type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | CanGetThumbnailByExtension |
Returns true if the filename's extension indicates Packflow can generate a thumbnail from its content.
Returns true for most image files and word 2010 files (when necessary components are available).
|
| ConvertToPdf |
This method is not implemented in this edition of PACKflow.
|
| Delete |
Flags this object as deleted.
(Inherited from PFBaseObject.)If it fails, throws an error. If the object could not be deleted because it does not yet exist in database, returns false. If successful, returns true. |
| GetAltUrl |
Gets the relative URL for the specified file. using the file name as last fragment
|
| GetThumbnail(Size) |
Creates a png thumbnail of the file if content is loaded and processable.
Image (jpg,tiff,bmp,png), Word 2010 (docx,docm) files are processed.
Keeps proportions.
Throws NotImplementedException if generation not supported for file.
Throws ObjectNotFoundException if file content was not loaded.
|
| GetThumbnail(Int32, Int32) |
Creates a png thumbnail of the file if content is loaded and processable.
Image (jpg,tiff,bmp,png), Word 2010 (docx,docm) files are processed.
Keeps proportions.
Throws NotImplementedException if generation not supported for file.
Throws ObjectNotFoundException if file content was not loaded.
|
| GetUrl(PFFile) |
Gets the relative URL for the specified file.
|
| GetUrl(PFContentType, Int64, Int64) |
Gets the relative URL for the specified file. using the file ID as last fragment
|
| LoadContentFromDatabase |
Loads the current file content from database and initializes the 'Content' value.
You may check the content presence by calling this.Data.IsValueAvailable("FieldName_Content");
Useful when working on a shallow copy.
Always catch InvalidStateExceptions. May be thrown if the file version in database is higher than the object's version.
In this case, reload the PFFile to work on up to date metadata.
|
| RunInTransactionArea |
Runs a code with a transaction on object connection.
If there is no current transaction and if the code succeed, transaction is committed.
If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.) |
| Save |
Applies the data of this object in the database.
(Overrides PFBaseObjectSave.)But also: -Updates ETag. -Updates WordForm status. -Updates ContentUpdatedAt. -Trigger multiple events. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateEtag |
Updates the Etag value from current date time ticks.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetReference |
Creates a file reference from a PFFile.
Returns null if the passed file is null.
(Defined by PFFileExtensions.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also