Gets 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.

'Declaration
 
Public ReadOnly Property ArtDataFileNameFormat As String

'Usage
 
Dim instance As MarkupFileImageDataProvider
Dim value As String
 
value = instance.ArtDataFileNameFormat

public string ArtDataFileNameFormat {get;}

public: __property string* get_ArtDataFileNameFormat();

public:
property String^ ArtDataFileNameFormat {
   String^ get();
}