Class FieldsContainerIntegrationClientBase
- Namespace
- Sfrep.AppraiseIt.Client.Integration.DataStore
- Assembly
- Sfrep.AppraiseIt.Client.Integration.dll
The base class that encapsulates data for the subject or a comparable in the dynamic data store.
public class FieldsContainerIntegrationClientBase : DataStoreIntegrationClientBase, IDisposable
- Inheritance
-
objectFieldsContainerIntegrationClientBase
- Implements
- Derived
- Inherited Members
-
object.Equals(object)object.Equals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()object.ReferenceEquals(object, object)object.ToString()
Constructors
FieldsContainerIntegrationClientBase(IntegrationClient, JoinableTaskFactory, IFieldsContainerIntegrationServerBase)
Creates a new instance.
protected FieldsContainerIntegrationClientBase(IntegrationClient integrationClient, JoinableTaskFactory joinableTaskFactory, IFieldsContainerIntegrationServerBase server)
Parameters
integrationClientIntegrationClientThe integration client connection.
joinableTaskFactoryJoinableTaskFactoryA JoinableTaskFactory used to start asyncronous Tasks from the main thread.
serverIFieldsContainerIntegrationServerBaseThe connection to the report's dynamic data store.
Properties
CompIndex
Gets the property's 0-based comparable index.
public int CompIndex { get; }
Property Value
- int
The comparable index. 0 is returned for the subject.
CompType
Gets this property's comparable type.
public string CompType { get; }
Property Value
- string
The comparable type. None is returned for the subject.
Methods
Clear(bool)
Clears all field data for this property.
public void Clear(bool clearImages = true)
Parameters
clearImagesboolTrue if and only if image and image list field data will be cleared.
Data for image and image list fields that occur in repeatable row groups or nested repeatable row groups is always cleared.
Dispose(bool)
Frees resources used by this instance.
protected override void Dispose(bool disposing)
Parameters
disposingboolTrue if called by the Dispose() method. False if called by the finalizer.
GetFields()
Gets the field data for this property.
public FieldsIndexIntegrationClient GetFields()
Returns
- FieldsIndexIntegrationClient
The field data for this property.
Remarks
Each call returns a new instance that, to prevent resource leaks, must be disposed by calling the Dispose method once it is no longer needed.