Class RasterBandClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("7ACA3D08-0629-11D2-8D24-0000F8780535")]
[ClassInterface(ClassInterfaceType.None)]
public class RasterBandClass : RasterBand, IRasterBand, IRasterBandEdit2, IRasterBandEdit, INativeTypeInfo, IRasterProps, IDataset, ITable, IObjectClass, IClass, IGeoDataset, IRasterDataset, IRasterTable, IRasterPyramid, IRawPixels, IMetadata, IMetadataEdit, IRasterTransaction, ISupportErrorInfo, IRawBlocks, IRasterBandColormap
Inheritance
RasterBandClass
Implements
Inherited Members

Explicit Interface Implementations

AcquireCache()

Gets reference to edit cache.

virtual object AcquireCache()

Returns

object

AddField(IField)

virtual void AddField(IField Field)

Parameters

Field IField

AddIndex(IIndex)

virtual void AddIndex(IIndex Index)

Parameters

Index IIndex

AliasName

The alias name of the object class.

virtual string AliasName { get; }

Returns

string

Remarks

Object classes in a geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The AliasName property returns the alias name for the object class. If the object class has no alias name, then AliasName will return the name of the object class (fully qualified if on ArcSDE). The alias name can be modified using the IClassSchemEdit interface.

AlterHistogram(IRasterHistogram)

Alters histogram.

virtual void AlterHistogram(IRasterHistogram pHistogram)

Parameters

pHistogram IRasterHistogram

AlterStatistics(IRasterStatistics)

Alters statistics.

virtual void AlterStatistics(IRasterStatistics pStats)

Parameters

pStats IRasterStatistics

AttributeTable

The attribute table of this raster band.

virtual ITable AttributeTable { get; }

Returns

ITable

Bandname

The name of this raster band.

virtual string Bandname { get; }

Returns

string

BasicOpenFromFile(string)

Opens the dataset from file.

virtual void BasicOpenFromFile(string Path)

Parameters

Path string

BrowseName

The browse name of the dataset.

virtual string BrowseName { get; set; }

Returns

string

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

CLSID

virtual UID CLSID { get; }

Returns

UID

CanCopy()

Returns true if this dataset can be copied.

virtual bool CanCopy()

Returns

bool

CanDelete()

True if this dataset can be deleted.

virtual bool CanDelete()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanEditMetadata

Indicates if metadata can be edited.

virtual bool CanEditMetadata { get; }

Returns

bool

Remarks

This property is available to those objects that support metadata.

CanRename()

True if this dataset can be renamed.

virtual bool CanRename()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Category

The category of the dataset.

virtual string Category { get; }

Returns

string

Remarks

IDataset::Category returns a description of the category of the dataset.  The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog.  The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

ClassNames

The class names (titles).

virtual IRasterClassNames ClassNames { get; }

Returns

IRasterClassNames

Colormap

The colormap of this raster band.

virtual IRasterColormap Colormap { get; }

Returns

IRasterColormap

Commit()

Sends all pending changes to persistent storage.

virtual void Commit()

CompleteName

The full path of the RasterDataset.

virtual string CompleteName { get; }

Returns

string

CompressionType

The compression technique applied to this RasterDataset.

virtual string CompressionType { get; }

Returns

string

ComputeStatisticsHistogram(int, int, object, bool)

Calculates statistics and histogram for a given skip factor.

virtual void ComputeStatisticsHistogram(int skipx, int skipy, object IgnoreValues, bool requireHistogram)

Parameters

skipx int
skipy int
IgnoreValues object
requireHistogram bool

ComputeStatsAndHist()

Calculates statistics and histogram if not previously stored.

virtual void ComputeStatsAndHist()

ComputeStatsHistogram(int)

Calculates statistics and histogram from a given pyramid level.

virtual void ComputeStatsHistogram(int PyramidLevel)

Parameters

PyramidLevel int

ContrastTable

The contrast look-up table of this band.

virtual IContrastTable ContrastTable { get; set; }

Returns

IContrastTable

Remarks

This method should not be used by application developers.

Copy(string, IWorkspace)

Copies this raster band to a new dataset with the specified name.

virtual IDataset Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Create()

Build raster pyramids for this raster.

virtual void Create()

CreateDefaultRaster()

Creates a raster object with the default properties for this dataset.

virtual IRaster CreateDefaultRaster()

Returns

IRaster

Remarks

The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.

CreatePixelBlock()

Create a compatible pixel block.

virtual IPixelBlock CreatePixelBlock()

Returns

IPixelBlock

CreatePixelBlock(IPnt)

Allocates a PixelBlock of size requested and type of this band.

virtual IPixelBlock CreatePixelBlock(IPnt Size)

Parameters

Size IPnt

Returns

IPixelBlock

Remarks

CreatePixelBlock method only initializes the properties of a pixel block, such as dimension, pixel type etc. Read method of this interface should be used to read pixels into the pixel block.

CreateRow()

Creates a row in the database with a system assigned object ID and null property values.

virtual IRow CreateRow()

Returns

IRow

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

CreateRowBuffer()

Creates a row buffer that can be used with an insert cursor.

virtual IRowBuffer CreateRowBuffer()

Returns

IRowBuffer

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Delete()

Deletes this dataset.

virtual void Delete()

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

DeleteField(IField)

virtual void DeleteField(IField Field)

Parameters

Field IField

DeleteIndex(IIndex)

virtual void DeleteIndex(IIndex Index)

Parameters

Index IIndex

DeleteSearchedRows(IQueryFilter)

Delete the Rows in the database selected by the specified query.

virtual void DeleteSearchedRows(IQueryFilter QueryFilter)

Parameters

QueryFilter IQueryFilter

DescriptorTable

The descriptor table of this raster band.

virtual IDescTable DescriptorTable { get; }

Returns

IDescTable

Remarks

This method should not be used by application developers.

DirectlyOpened

Indicates if the band was opened directly.

virtual bool DirectlyOpened { get; set; }

Returns

bool

Remarks

This method should not be used by application developers.

EXTCLSID

virtual UID EXTCLSID { get; }

Returns

UID

End()

Commits changes and stops double buffering.

virtual void End()

Extension

virtual object Extension { get; }

Returns

object

ExtensionProperties

virtual IPropertySet ExtensionProperties { get; }

Returns

IPropertySet

Extent

The extent of the Raster.

virtual IEnvelope Extent { get; set; }

Returns

IEnvelope

Fields

virtual IFields Fields { get; }

Returns

IFields

FindField(string)

virtual int FindField(string Name)

Parameters

Name string

Returns

int

Flush()

Flushes buffered data.

virtual void Flush()

Format

The format of this RasterRataset.

virtual string Format { get; }

Returns

string

FullName

The associated name object.

virtual IName FullName { get; }

Returns

IName

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

GetRow(long)

The row from the database with the specified object ID.

virtual IRow GetRow(long OID)

Parameters

OID long

Returns

IRow

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

GetRows(object, bool)

The cursor of rows based on a set of object ids.

virtual ICursor GetRows(object oids, bool Recycling)

Parameters

oids object
Recycling bool

Returns

ICursor

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

The oids parameter should be passed an integer array. For example:

 

[C#]

// Get a recycling cursor for the OID array.

int[] oidArray = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.GetRows(oidArray, true);

HasColormap()

Indicates if this band has a colormap.

virtual bool HasColormap()

Returns

bool

HasColormap(out bool)

Indicates if this band has a colormap.

virtual void HasColormap(out bool b)

Parameters

b bool

HasOID

virtual bool HasOID { get; }

Returns

bool

HasStatistics(out bool)

Indicates if this band has statistics.

virtual void HasStatistics(out bool b)

Parameters

b bool

HasTable(out bool)

Indicates if this band has an attribute table.

virtual void HasTable(out bool b)

Parameters

b bool

Height

Height in pixels.

virtual int Height { get; set; }

Returns

int

Histogram

The histogram of this raster band.

virtual IRasterHistogram Histogram { get; }

Returns

IRasterHistogram

IDataset_CanCopy()

True if this dataset can be copied.

virtual bool IDataset_CanCopy()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

  • CAD Drawings
  • Coverages
  • DBase Tables
  • Info Tables
  • Raster Datasets
  • SDC datasets
  • SDC Network Datasets
  • Shapefiles
  • Shapefile Network Datasets

IDataset_Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset IDataset_Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

IGeoDataset_Extent

The extent of the GeoDataset.

virtual IEnvelope IGeoDataset_Extent { get; }

Returns

IEnvelope

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

 

IGeoDataset_SpatialReference

The spatial reference of the GeoDataset.

virtual ISpatialReference IGeoDataset_SpatialReference { get; }

Returns

ISpatialReference

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

IObjectClass_AddField(IField)

virtual void IObjectClass_AddField(IField Field)

Parameters

Field IField

IObjectClass_AddIndex(IIndex)

virtual void IObjectClass_AddIndex(IIndex Index)

Parameters

Index IIndex

IObjectClass_CLSID

virtual UID IObjectClass_CLSID { get; }

Returns

UID

IObjectClass_DeleteField(IField)

virtual void IObjectClass_DeleteField(IField Field)

Parameters

Field IField

IObjectClass_DeleteIndex(IIndex)

virtual void IObjectClass_DeleteIndex(IIndex Index)

Parameters

Index IIndex

IObjectClass_EXTCLSID

virtual UID IObjectClass_EXTCLSID { get; }

Returns

UID

IObjectClass_Extension

virtual object IObjectClass_Extension { get; }

Returns

object

IObjectClass_ExtensionProperties

virtual IPropertySet IObjectClass_ExtensionProperties { get; }

Returns

IPropertySet

IObjectClass_Fields

virtual IFields IObjectClass_Fields { get; }

Returns

IFields

IObjectClass_FindField(string)

virtual int IObjectClass_FindField(string Name)

Parameters

Name string

Returns

int

IObjectClass_HasOID

virtual bool IObjectClass_HasOID { get; }

Returns

bool

IObjectClass_Indexes

virtual IIndexes IObjectClass_Indexes { get; }

Returns

IIndexes

IObjectClass_OIDFieldName

virtual string IObjectClass_OIDFieldName { get; }

Returns

string

IRasterBandColormap_Colormap

The colormap of this raster band.

virtual IRasterColormap IRasterBandColormap_Colormap { get; set; }

Returns

IRasterColormap

IRasterBandEdit2_AlterHistogram(IRasterHistogram)

virtual void IRasterBandEdit2_AlterHistogram(IRasterHistogram pHistogram)

Parameters

pHistogram IRasterHistogram

IRasterBandEdit2_AlterStatistics(IRasterStatistics)

virtual void IRasterBandEdit2_AlterStatistics(IRasterStatistics pStats)

Parameters

pStats IRasterStatistics

IRasterBandEdit2_ComputeStatsHistogram(int)

virtual void IRasterBandEdit2_ComputeStatsHistogram(int PyramidLevel)

Parameters

PyramidLevel int

IRasterDataset_CanCopy()

Returns true if this dataset can be copied.

virtual bool IRasterDataset_CanCopy()

Returns

bool

IRasterDataset_Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset IRasterDataset_Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Indexes

virtual IIndexes Indexes { get; }

Returns

IIndexes

Insert(bool)

Returns a cursor that can be used to insert new Rows.

virtual ICursor Insert(bool useBuffering)

Parameters

useBuffering bool

Returns

ICursor

Remarks

The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsInteger

Indicates if the data is integer.

virtual bool IsInteger { get; }

Returns

bool

MapModel

Map to raster transformation information.

virtual IRasterMapModel MapModel { get; set; }

Returns

IRasterMapModel

MeanCellSize()

Returns the approximate cell size of the raster.

virtual IPnt MeanCellSize()

Returns

IPnt

Metadata

The PropertySet containing metadata.

virtual IPropertySet Metadata { get; set; }

Returns

IPropertySet

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

MinimumSize

The minimum raster pyramid size.

virtual IPnt MinimumSize { get; set; }

Returns

IPnt

Name

The name of the Dataset.

virtual string Name { get; }

Returns

string

NativeType

The native type.

virtual INativeType NativeType { get; }

Returns

INativeType

NoDataValue

Data value used to indicate invalid or excluded data.

virtual object NoDataValue { get; set; }

Returns

object

Remarks

Specifying a single NoData value for a multiband raster, the NoData value will apply to each raster band in the raster. To set different NoData value for each band, pass an array, each element in the array sets the NoData value for the corresponding band, to this property.

NumCacheRefs

Number of outstanding cache references

virtual int NumCacheRefs { get; }

Returns

int

OIDFieldName

virtual string OIDFieldName { get; }

Returns

string

ObjectClassID

The unique ID for the object class.

virtual int ObjectClassID { get; }

Returns

int

Remarks

Each feature class or table registered with the geodatabase is an object class. Object classes have a unique ID which distinguishes them from other object classes in the geodatabase. The ObjectClassID property returns this ID as a long. The object class ID is assigned by the system when the class is created, or registered with the geodatabase, it cannot be modified.

Those feature classes and tables that are in the database, but not registered with the geodatabase will always have an object class ID of -1.

OpenFromFile(string)

Attaches dataset to a particular file.

virtual void OpenFromFile(string Path)

Parameters

Path string

PixelType

Data type of the pixels.

virtual rstPixelType PixelType { get; set; }

Returns

rstPixelType

PrecalculateStats(object)

Calculates statistics and histograms for specified bands.

virtual void PrecalculateStats(object index_list)

Parameters

index_list object

Present

Indicates whether pyramid layers exist.

virtual bool Present { get; }

Returns

bool

PrimaryField

The primary field of the table.

virtual int PrimaryField { get; set; }

Returns

int

PropertySet

The set of properties for the dataset.

virtual IPropertySet PropertySet { get; }

Returns

IPropertySet

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

RasterDataset

The RasterDataset associated with this raster band.

virtual IRasterDataset RasterDataset { get; }

Returns

IRasterDataset

Remarks

<P>The <STRONG>RasterDataset</STRONG> object represents a dataset on disk or in a database. It is composed of one or more persistent raster bands. The dataset provides access only to operations that apply to the entire dataset, with the <STRONG>RasterBand</STRONG> providing access to operations that occur on individual bands.</P> <P>The RasterDataset object performs basic dataset management functions, such as copy, rename, and delete. It can also instantiat RasterBand and <STRONG>Raster</STRONG> objects representing other aspects of the data. It can be used to examine dataset properties including different format, extent, spatial reference, and number of bands.</P> <P>The spatial reference of the raster raster dataset can be changed through interface <STRONG>IGeoDatasetSchemaEdit</STRONG>, but it does not project the dataset, only changes the coordinate system associated with the dataset.<BR>The pyramid of the raster dataset can be built or rebuilt to improve display performance for large raster datasets.</P>

RasterInfo

The raster information.

virtual IRasterInfo RasterInfo { get; }

Returns

IRasterInfo

Read(IPnt, IPixelBlock)

Read a block of pixels starting from tlc (top left corner).

virtual void Read(IPnt tlc, IPixelBlock pxls)

Parameters

tlc IPnt
pxls IPixelBlock

ReadBlock(int, int, int, IPixelBlock)

Reads a raw pixel block.

virtual void ReadBlock(int tx, int ty, int Level, IPixelBlock pPixelBlock)

Parameters

tx int
ty int
Level int
pPixelBlock IPixelBlock

RelationshipClasses[esriRelRole]

The relationship classes in which this object class participates in for the specified role.

virtual IEnumRelationshipClass RelationshipClasses[esriRelRole Role] { get; }

Parameters

Role esriRelRole

Returns

IEnumRelationshipClass

Remarks

Object classes in a geodatabase may participate in any number of relationships classes. The RelationshipClasses property allows you to get a list of those relationship classes that the object class participates in by what role it plays (origin, destination, or either) defined by the esriRelRole enumeration used when you call this property. This property returns a IEnumRelationshipClass interface which you can use to loop through those relationship classes that are returned.

Rename(string)

Renames this Dataset.

virtual void Rename(string Name)

Parameters

Name string

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network.  In addition, certain feature classes, such as network feature classes, cannot be renamed.

RepresentationType

The suggested representation type.

virtual rstRepresentationType RepresentationType { get; set; }

Returns

rstRepresentationType

ReturnCache(object)

Restores edit cache to previous state.

virtual int ReturnCache(object cache)

Parameters

cache object

Returns

int

RowCount(IQueryFilter)

The number of Rows selected by the specified query.

virtual long RowCount(IQueryFilter QueryFilter)

Parameters

QueryFilter IQueryFilter

Returns

long

Search(IQueryFilter, bool)

An object cursor that can be used to fetch row objects selected by the specified query.

virtual ICursor Search(IQueryFilter QueryFilter, bool Recycling)

Parameters

QueryFilter IQueryFilter
Recycling bool

Returns

ICursor

Remarks

The Search method returns a search cursor that can be used to retrieve rows specified by a query filter. The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor.

Row objects returned by a recycling cursor should not be modified. Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees ‘unique instance semantics’ on non-recycling row objects fetched during an edit session. If the row object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing row object is returned.

Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class.  This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry.  Using a non-recycling cursor ensures that each geometry is unique.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Select(IQueryFilter, esriSelectionType, esriSelectionOption, IWorkspace)

A selection that contains the object ids selected by the specified query.

virtual ISelectionSet Select(IQueryFilter QueryFilter, esriSelectionType selType, esriSelectionOption selOption, IWorkspace selectionContainer)

Parameters

QueryFilter IQueryFilter
selType esriSelectionType
selOption esriSelectionOption
selectionContainer IWorkspace

Returns

ISelectionSet

Remarks

The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter. 

SensorType

The sensor type used for this RasterDataset.

virtual string SensorType { get; }

Returns

string

SpatialReference

SpatialReference of the Raster.

virtual ISpatialReference SpatialReference { get; set; }

Returns

ISpatialReference

Start()

Starts double buffering edits for undo support.

virtual void Start()

Statistics

The statistics of this raster band.

virtual IRasterStatistics Statistics { get; }

Returns

IRasterStatistics

Subsets

Datasets contained within this dataset.

virtual IEnumDataset Subsets { get; }

Returns

IEnumDataset

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network.  To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Synchronize(esriMetadataSyncAction, int)

Updates metadata with the current properties; may create metadata if it doesn't already exist.

virtual void Synchronize(esriMetadataSyncAction action, int interval)

Parameters

action esriMetadataSyncAction
interval int

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action Metadata status Esri/Sync element Interval parameter
esriMSAAccessed Doesn't matter Must not be FALSE Must be less than actual interval
esriMSAAlways Doesn't matter Doesn't matter Doesn't matter
esriMSACreated Must not exist Must not be FALSE Must be less than actual interval
esriMSANotCreated Must exist Must not be FALSE Must be less than actual interval
esriMSAOverwrite Doesn't matter Doesn't matter Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

TableType

The class names of the table.

virtual esriRasterTableTypeEnum TableType { get; }

Returns

esriRasterTableTypeEnum

Type

The type of the Dataset.

virtual esriDatasetType Type { get; }

Returns

esriDatasetType

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Undo(int)

Reverses last N changes.

virtual int Undo(int N)

Parameters

N int

Returns

int

UndoLevels

Maximum number of reversible operations.

virtual int UndoLevels { get; set; }

Returns

int

Update(IQueryFilter, bool)

Returns a cursor that can be used to update Rows selected by the specified query.

virtual ICursor Update(IQueryFilter QueryFilter, bool Recycling)

Parameters

QueryFilter IQueryFilter
Recycling bool

Returns

ICursor

Remarks

The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

UpdateSearchedRows(IQueryFilter, IRowBuffer)

Update the Rows in the database selected by the specified query.

virtual void UpdateSearchedRows(IQueryFilter QueryFilter, IRowBuffer buffer)

Parameters

QueryFilter IQueryFilter
buffer IRowBuffer

Width

Width in pixels.

virtual int Width { get; set; }

Returns

int

Workspace

The workspace containing this dataset.

virtual IWorkspace Workspace { get; }

Returns

IWorkspace

Remarks

<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>

Write(IPnt, IPixelBlock)

Write a block of pixels starting from tlc (top left corner).

virtual void Write(IPnt tlc, IPixelBlock pxls)

Parameters

tlc IPnt
pxls IPixelBlock

WriteBlock(int, int, int, IPixelBlock)

Writes a raw pixel block.

virtual void WriteBlock(int tx, int ty, int Level, IPixelBlock pPixelBlock)

Parameters

tx int
ty int
Level int
pPixelBlock IPixelBlock