ImageGear .NET v24.12 - Updated
MarkupSqlImageDataProvider Class Members
Properties  Methods 


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

The following tables list the members exposed by MarkupSqlImageDataProvider.

Public Constructors
 NameDescription
Public ConstructorMarkupSqlImageDataProvider Constructor  
Top
Public Properties
 NameDescription
Public PropertyArtConnectionStringNameThe name of the connection string to use to connect to the database used to store and retrieve annotations  
Public PropertyDescriptionOverridden.  Gets or sets the description for this provider.  
Public PropertyInitSqlCacheDependencyWhether to register the connection string for receiving dependency change notifications . .  
Public PropertyParamKeySqlDbTypeThe SqlDbType System.Data.SqlDbType of SqlParameter. This is the SQL data type of the primary key of the table used to store and retrieve images. If this is specified, then a data type check will be performed when adding the parameter to construct the SqlCommand used to execute the query. This is required in order for a length check to be performed on SqlParameter with ParamKeyLength.  
Public PropertySqlArtDataFieldThe name of the column which stores annotation data in the table that stores annotations  
Public PropertySqlArtInsertCommandThe SQL query or stored procedure used to insert a new art document into the annotations table  
Public PropertySqlArtInsertCommandTypeThe Command Type for SqlArtInsertCommand System.Data.CommandType. This can be either "Text" or "StoredProcedure" as specified in Web.config. TableDirect is unsupported.  
Public PropertySqlArtKeyArtIdFieldThe name of the column which stores the Markup Layer Record ID in the Annotations table, which is part of the composite key used to store Annotations. This is required so that the back-end may know which column corresponds to the Markup Layer Record ID in SqlArtListCommand.  
Public PropertySqlArtKeyArtIdParameterThe parameter that is used to specify the Markup Layer Record ID when constructing SQL Commands dealing with annotations. . .  
Public PropertySqlArtKeyArtIdSqlDbTypeThe SqlDbType System.Data.SqlDbType of SqlArtKeyArtIdParameter. This is the SQL data type of field used to store the Markup Layer Record ID, part of the composite key used to store and retrieve annotations from the Annotations table. If this is specified, then a data type check will be performed when adding the parameter to construct the SqlCommand used to execute the query. This is required in order for a length check to be performed on SqlArtKeyArtIdParameter with SqlArtKeyArtIdParamLength.  
Public PropertySqlArtKeyDocumentIdFieldThe name of the column that stores annotation data in the table that stores annotations  
Public PropertySqlArtKeyDocumentIdParameterThe parameter that is used to specify the Document Identifier, part of the composite key used to store and retrieve annotations, when constructing Sql Commands that operate on the Annotations table. . .  
Public PropertySqlArtKeyDocumentIdSqlDbTypeThe SqlDbType System.Data.SqlDbType of SqlArtKeyDocumentIdParameter. This is the SQL data type of the field in the Annotations table that corresponds to the Document Identifier, which is part of the composite key for the Annotations Table. If this is specified, then a data type check will be performed when adding the parameter to construct the SqlCommand used to execute the query. This is required in order for a length check to be performed on SqlArtKeyDocumentIdParameter with SqlArtKeyDocumentIdParamLength.  
Public PropertySqlArtListCommandThe SQL query or stored procedure used to retrieve a list of Markup Layer Record IDs (part of a  
Public PropertySqlArtListCommandTypeThe Command Type for SqlArtListCommand System.Data.CommandType. This can be either "Text" or "StoredProcedure" as specified in Web.config. TableDirect is unsupported.  
Public PropertySqlArtMarkupNameFieldThe name of the column which stores the Markup Layer Name in the table that stores annotations. The Markup Layer Name is a user-friendly and non-unqiue name to associate with a Markup Layer that may be displayed to the user as a mnemonic in the client viewer.  
Public PropertySqlArtMarkupNameParameterThe parameter that is used to insert document data into the database for insert operations . .  
Public PropertySqlArtMarkupNameSqlDbTypeThe SqlDbType System.Data.SqlDbType of SqlArtMarkupNameParameter. This is the SQL data type of the field used to store the Markup Layer Name in the annotations table. If this is specified, then a data type check will be performed when adding the parameter to construct the SqlCommand used to execute the query. This is required in order for a length check to be performed on SqlArtMarkupNameParameter with SqlArtMarkupNameParamLength.  
Public PropertySqlArtParameterThe parameter that is used to specify the annotation data into the database for annotation insert and update operations . If this is enabled, documents will be cached with a dependency on the SqlCommand which embodies the query by which they were obtained such that any change in the results of the query would be automatically detected and the cached item will become invalid.  
Public PropertySqlCommandThe SQL query or stored procedure used to retrieve documents from the database  
Public PropertySqlCommandTypeThe Command Type for SqlCommand System.Data.CommandType. This can be either "Text" or "StoredProcedure" as specified in Web.config. TableDirect is unsupported. Will default to Text.  
Public PropertySqlImageDataFieldThe name of the column in which image data is stored  
Public PropertySqlImageDataFieldBlobIndicates whether the table used for the storage of documents in the database contains the actual documents, or an alternate mapping of Document IDs to file names in the file system from StorageRootPath. If this is true, then documents are stored directly in and retrieved directly from the database. If it is false, then the content of the data field in the table used for storing documents will be retrieved and interpreted as the Document ID, effectively using the documents table as a mechanism for creating an alternate mapping for Document IDs to the file system.

A new property, UseImageTable UseImageTable, has been added to this DataProvider UseImageTable which indicates that a Document table will not be used at all and Document IDs will be directly routed to StorageRootPath in the file system.

 
Public PropertySqlImageDataParameterThe parameter that is used to insert document data into the database for insert operations . An SQL parameter is used like a variable identifier and should appear in relevant queries. MSSQL parameters should begin with the '@' symbol.  
Public PropertyStorageRootPathThe root path to and from which documents will be stored and retrieved in the file system. This only applies if SqlImageDataFieldBlob is specified as "false". SqlImageDataFieldBlob. Paths that begin with a tilde '~' will be mapped to the server application root directory.  
Public PropertyUseImageTableIndicates that the database is to be used for the storage of documents. If this is false, only annotations will be stored in the database and any requests for documents will be routed to the file system and attempted to be read from StorageRootPath. If this is false, any properties concerning the storage and retrieval of documents from the database will be ignored as they are no longer relevant.  
Top
Public Methods
 NameDescription
Public MethodOpenImageDataOverridden.  Opens connection for obtaining image data from the File storage system.  
Top
See Also

Reference

MarkupSqlImageDataProvider Class
ImageGear.Web.DataProviders Namespace

 

 

©2020. Accusoft Corporation. All Rights Reserved.

Send Documentation Feedback  |  Get Product Support