Class CapturedFile
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
The CapturedFile class represents a file captured by adTempus due to a File Capture Action.
[ComVisible(true)]
[Guid("12235ef6-faa7-4d79-b385-cac7d2848679")]
public sealed class CapturedFile : ADTObject
- Inheritance
-
objectCapturedFile
Properties
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
CaptureType
The type of capture action.
public string CaptureType { get; }
Property Value
- string
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
Description
A description of the file.
public string Description { get; }
Property Value
- string
FileDate
The last modified timestamp of the file.
[ComVisible(false)]
public DateTime? FileDate { get; }
Property Value
- DateTime?
FileSize
The size of the file
public long FileSize { get; }
Property Value
- long
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
OriginalFileName
The original name of the file.
public string OriginalFileName { get; }
Property Value
- string
OriginalPath
The original path of the file.
public string OriginalPath { get; }
Property Value
- string
Methods
FindOwningObject()
Get the owner of this object based on relationships.
protected override ADTObject FindOwningObject()
Returns
- ADTObject
The owning object, or null if the object is not owned by another object or the owner has not been set.
GetContents()
Retrieves the file data from the server and returns it as a byte array.
public byte[] GetContents()
Returns
- byte[]
Remarks
This might not be a good idea for large files. Use WriteContentsToFile(string) or WriteContentsToStream(Stream) instead.
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
WriteContentsToFile(string)
Retrieves the file data from the server and returns it to a local file.
public void WriteContentsToFile(string fileName)
Parameters
| Name | Type | Description |
|---|---|---|
fileName |
string |
WriteContentsToStream(Stream)
Retrieves the file data from the server and returns it to a stream.
public void WriteContentsToStream(Stream stream)
Parameters
| Name | Type | Description |
|---|---|---|
stream |
Stream |
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)