ImageGear .NET - Updated
MarkupFileImageDataProvider Class Properties


ImageGear24.Web.Services Assembly > ImageGear.Web.DataProviders Namespace : MarkupFileImageDataProvider Class

For a list of all members of this type, see MarkupFileImageDataProvider members.

Public Properties
 NameDescription
Public PropertyArtDataFileNameFormatGets the Art Data File Name Format specified in Web.config for this Data Provider used to store and retrieve Markup Layers to disk. The file names of Markup Layers are significant as this Data Provider may use a directory listing of the ArtStorageRootPath and parse the file names of the documents within to obtain Markup Layer Record IDs for Markup Layers associated with a particular Document ID.

The ArtDataFileNameFormat should include all 3 format strings for the Document Identifier, Separator Token, and Markup Layer Record ID in order to be able to reliably parse the file names to obtain a listing of the Markup Layers associated with a particular Document ID. As this is a File Data Provider, the separator character must be a valid OS File Name Character, however, it is suggested that this character be reserved and not used as a part of any Document ID or Markup Layer Record ID in order to avoid ambiguity when parsing the file names and obtaining the Markup Layer List.

You may alter the Markup Layer Record IDs generated through the use of Art Middleware, however, by default, Markup Layer Record IDs will be GUIDs. This structured and reliable format for Markup Layer Record IDs will reduce the likelihood of ambiguity. The last instance of SeparatorToken in the file name will be used in parsing to obtain the Document ID and Markup Layer Record ID for a given Art Document file name.

The following case-insensitive format substrings can be used when specifying the Art Data File Name Format.

Parameter Format Substring Specifiers
Document Identifier "{0}", "{DID}", "{DocID}", "{DocumentID}", "{DocumentIdentifier}"
Separator Token "{1}", "{Sep}", "{Separator}", "{SeparatorToken}"
Markup Layer Record ID "{2}", "{MID}", "{MarkID}", "{MarkupID}", "{MarkupLayerID}", "{LayerRecordID}", "{MarkupLayerRecordID}"

The default format used to store Markup Layers is "{DocID}{Sep}{MarkID}.xml". Be careful with naming conventions to avoid the possibility of ambiguity and naming collisions.  
Public PropertyArtStorageRootPath Gets the Art Storage Root Path specified in Web.config for this Data Provider. This path is the path from which all Markup Layers are served and the path to which new Markup Layers will be stored.  
Public PropertyCachingEnable Gets the Caching Enable value for this Data Provider specified in Web.config. This is a boolean value indicating whether or not document memory caching is to be enabled.  
Public PropertyCachingTimeLimit Gets the Caching Time Limit for this Data Provider specified in Web.config. This is the maximum time in minutes to retain a cached document cached in RAM.  
Public PropertyDescriptionOverridden.  Gets the description for this provider.  
Public PropertyMarkupIndexFileNameFormatGets the Markup Index File Name Format for this Data Provider specified in Web.config. The Markup Index File stores a list of all the Markup Layers associated with a particular Document ID. The only format substring which may be used indicates the Document Identifier for the corresponding document and must be specified, otherwise the default format will be used instead.

The following case-insensitive format substrings can be used when specifying the Art Data File Name Format.

Parameter Format Substring Specifiers
Document Identifier "{0}", "{DID}", "{DocID}", "{DocumentID}", "{DocumentIdentifier}"

The default format used to store Markup Layer Index Files is "{DocID}.layers.json". Be careful with naming conventions to avoid the possibility of ambiguity and naming collisions.  
Public PropertyMaxImageSizeToCache Gets the Max Image Size To Cache specified in Web.config for this Data Provider. This is the maximum size in bytes of documents to cache in RAM.  
Public PropertyNameOverridden.  Gets the friendly name used to refer to the provider during configuration.  
Public PropertySeparatorToken Gets the Separator Token specified for this Data Provider in Web.config. This character will be used to delimit parts of the formatted file names used to store Markup Layers in a fashion such that they can be later parsed.  
Public PropertyStorageRootPath Gets the Storage Root Path specified in Web.config for this Data Provider. This path is the path from which all documents will be served, and the path to which uploaded documents will be stored.  
Public PropertyUseDirectoryListingGets the Use Directory Listing value for this Data Provider specfied in Web.config. This value indicates whether a directory listing per the Art Data File Name Format is to be used to determine the association between documents and Markup Layers. Defaults to true. If this is set to false, the Developer will likely want to provide their own mechanism for retrieving a Markup Layer List for a given Document Identifier. This can be done either by a complete Data Provider implementation MarkupImageDataProvider, or by using MarkupArtMiddleware MarkupArtMiddleware.  
Public PropertyUseMarkupIndexFileGets the Use Markup Index File value for this Data Provider specified in Web.config. This is a boolean value indicating whether a Markup Index File is to be used. A Markup Index file is a JSON file containing the Markup Layer List for a particular Document ID. This list may be generated using a directory listing if UseDirectoryListing is specified UseDirectoryListing.  
Public PropertyUseMarkupIndexFileCache Only applicable if UseMarkupIndexFile is true. A boolean value which indicates whether to Cache Markup Index Files in RAM.  
Top
See Also

Reference

MarkupFileImageDataProvider Class
ImageGear.Web.DataProviders Namespace

 

 

©2018. Accusoft Corporation. All Rights Reserved.

Send Feedback