Class vdFileProperties
- Namespace
- VectorDraw.Professional.vdObjects
- Assembly
- VectorDraw.Professional.dll
Represents the file properties of a Document.
public sealed class vdFileProperties : BaseObject, IDisposable, IBaseObject, IVDSerialise- Inheritance
-
vdFileProperties
- Implements
- Inherited Members
Constructors
- vdFileProperties()
Initializes the vdFileProperties object.
Properties
- Author
Get/Set a string representing the author for the Document's file.
- CacheLevel
Gets or sets the cache policy when opening a drawing from a url.Not saved with drawing. vaid values: 0 :NoCache ,No entries are taken from caches, added to caches, or removed from caches between the client and server 1 :BypassCache ,Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. 2 :CacheOnly ,Satisfies a request using the locally cached resource; does not send a request for an item that is not in the cache. 3 :CacheIfAvailable ,Satisfies a request for a resource from the cache, if the resource is available; otherwise, sends a request for a resource to the server. If the requested item is available in any cache between the client and the server, the request might be satisfied by the intermediate cache. 4 :Revalidate ,Satisfies a request by using the cached copy of the resource if the timestamp is the same as the timestamp of the resource on the server; otherwise, the resource is downloaded from the server, presented to the caller, and stored
in the cache. 5 :Reload ,Satisfies a request by using the server. The response might be saved in the cache. In the HTTP caching protocol, this is achieved using the no-cache cache control directive and the no-cache Pragma header. 6 :NoCacheNoStore ,Never satisfies a request by using resources from the cache and does not cache resources. If the resource is present in the local cache, it is removed. default value = 3
- ClipboardFormat
Specifies the data used from the CmdClipCopy(object) and CmdClipCut(object) commands.
- CompareDocumentSettings
Controls the display of the results used by CmdCompare(object, object, bool)
- CompressionMethod
Get/Set the compression method used to save the data.
- ContainsLargeRangeCharacters
Specifies if the document contains strings with characters in range bigger than 56207.Used when saving in vdml or vdcl format. This may slow down the saving time. Set it to true , before saving the document in vdml,vdcl format, if you are using serializable string properties with characters in range bigger than 56207. Default value is false.
- CreatedTime
Get a DateTime object representing the date the file was created in UTC format.
- CustomProperties
Get an array of the Custom properties of the file.It is recommended that the custom properties follow the rule Tag=value.
- DefaultDrawingCodePage
Get/Set the Default Code Page of the drawing.
- DefaultPDFPage
Default pdf page number to be loaded when open a pdf file
if it is less than zero then all pages are loaded as separate layouts with page name as "Page 1","Page 2" etc.
Default value is -2 which means that all pages are loaded. This property is considered by the following methods and operations:ImportFromFile(string) (where PDF pages are imported into the document as separate layouts).
AddFromFile(string, string, MergeTablesFlags)
cmdAttachAllPDFPagesEx(vdDocument)
- DoublePrecision
Get/Set the maximum number of decimal digits used when saving double values in vdml format.Valid range 0 - 17
- DwgMeshTessellation
Specify the tessellation quality of imported dwg 3d solid circular surfaces (such as Cone, Torus, Sphere or Cylinder), in order to convert to vdPolyface objects.
It is measured in degrees. The value of this parameter determines the quantity of mesh cells (triangles) used to represent a circular surface
Valid range betrween 0 to 360.Default value is 15.
- EMFImportProperties
Get/Set the EMF import properties used when opening an Emf or Wmf file.
- ExportDWGFlags
Controls the export of dwg/dgn files.
- ExternalFileVersion
Get/Set a string representing the version of the Document's file.
- FilePermissions
Get/Set the File Permissions for this Document.
- Gps_Map
This property is to set the longtitude and latidude of a drawing and use this setting while exporting to PDF format.
- IFCImportProperties
Get/Set the IFC import properties used when opening a IFC file.
- ImagePreviewSize
Get/Set the preview image size of the file.
- ImageSaveJPGQuality
Get/Set the default image quality (0=lowest to 100=highest) when saving in a raster JPG image using the SaveAs(string, Image) method and the vdPrint to export to image.
- ImportDWGFlags
Controls the import of dwg files.
- LoadLocalNetworkFilesTimeout
Get/Set the timeout used when loading network files.
Default value is -1 and the timeout is infinity whaiting the procedure to finish
Set it to 0 in order to disable loading network files
Set to a positive value to define the maximum milliseconds that the FileInfo Exists can use before aborted
- ModifiedTime
Get a DateTime object representing the date the file was modified last time in UTC format.
- OBJImportProperties
Get/Set the OBJ import properties used when opening a OBJ file.
- OwnerPassword
Get/Set the owner password currently used for PDF export.
It must be a valid not an empty password string in order PDFExportProperties Allow permissions to be applied
and all contents of the document to be encrypted and search engines cannot acces the document's metadata
GetPassWord event is fired.If not implemented by the application, then a default dialog box appears to set the password.
- PDFExportDefaultNavigationPane
Get/Set the default navigation pane when saving in PDF format.
- PDFExportProperties
Get/Set the PDF export properties used when saving in PDF format.
- PDFImportProperties
Get/Set the PDF import properties used when opening a PDF file.
- PDFImportResolution
Gets or sets the raster resolution (in DPI) used when importing PDF pages as images.
- SVGExportProperties
Get/Set the SVG export properties used when saving in SVG format.
- SaveImagePreview
Get/Set a boolean value representing if the preview image will be saved wwhen the file is saved or not.
- Subject
Get/Set a string representing a subject for the Document's file.
- Title
Get/Set a string representing a title for the Document's file.
- TotalEditingTime
Get the total editing time of the file.
- UseGuidHandleTable
A static property that enable / disable the Guid Table Creation for a vdDocument object. HandleTableGuid property. Default value is false.Changing this value is applied to all vdDocument objects. This value is better to be assign in the application initialization.
- UserPassword
Get/Set the user password currently used for PDF export.
GetPassWord event is fired.If not implemented by the application, then a default dialog box appears to set the password.
if it is a valid not an empty password string all contents of the document to be encrypted and search engines cannot acces the document's metadata
if you want PDFExportProperties Allow permissions to be set and not require a password, set OwnerPassword to a valid not empty string and UserPassword to an empty string
if you want PDFExportProperties Allow permissions to be set and a password require, set different passwords for OwnerPassword and UserPassword and open PDF with UserPassword
if you want NO PDFExportProperties Allow permissions to be set and a password require, set empty string for OwnerPassword, not empty for UserPassword
if it is not empty and the OwnerPassword is empty string then the open of PDF require this password and the PDFExportProperties Allow permissions are not applied
If it is empty and OwnerPassword is not empty then the PDF does not require a password to open and PDFExportProperties Allow permissions applied
if it is not empty and the OwnerPassword is not empty and different than UserPasswordthen PDF can be open
1.with UserPassword and PDFExportProperties Allow permissions applied
2.with OwnerPassword and PDFExportProperties Allow permissions are not applied
if it is not empty and the OwnerPassword is the same as UserPassword then the open of PDF require this password and the PDFExportProperties Allow permissions are not applied
If both UserPassword and OwnerPassword no password no permissions applied to the PDF file
- XProperties
Gets the Collection of vdXProperties of the object.
- vdExportFlags
This property is used while exporting vdml,vdcl files.
A global property used by all documents
Default value is UseStreamedArrays
vdExportFlags
Methods
- Clone()
Creates and returns a copy of this vdFileProperties object.
- CopyFrom(vdFileProperties)
Copies all properties from the passed vdFileProperties object.
- CopyFrom(vdFileProperties, bool)
Copies all properties from the passed vdFileProperties object.
- DeSerialize(DeSerializer, string, object)
This Function is called foreach field name of the vdFileProperties object when opening in vdml format.
- GetOpenDialogFilter()
A public method that returns the filter string used in our open dialog.
- GetPreviewBitmapBytes()
Get the preview image of the file of the Document.
- GetPreviewBitmapDIBBytes()
Get the bytes of the preview without the BITMAPFILEHEADER.
- GetPreviewImage()
Get the preview image of the file.
- GetSaveDialogFilter()
A public method that returns the filter string used in our save dialog.
- OnSaveUpdateTime()
Updates the file properties times(ModifiedTime,TotalEditingTime) using the current system time.
- Reset()
Resets all file properties
- Serialize(Serializer)
This Function is called when saving the vdFileProperties object to vdml format.
- SetCreatedTime(long)
Sets the Create time from a Windows file UTC time (long) object.
- SetModifiedTime(long)
Sets the Modified time from a Windows file UTC time (long) object.
- SetPreviewImage(Image)
Set the another preview for the Document's file.
- SetPreviewImageFromLayout(vdLayout)
Select the active preview image, used when save a drawing, to the passed layout graphic representation
- ToString()
Gets a System.String that represents the Created time of the Document object.