XmlMappedRange Interface

Definition

An XmlMappedRange control is a range that is created when a non-repeating schema element is mapped onto a cell.

[System.Runtime.InteropServices.Guid("ac172e76-a2b5-4fcc-ae02-65ce23f50cb3")]
public interface XmlMappedRange : IDisposable, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
Attributes
Implements

Remarks

The XmlMappedRange control only supports binding to a single data field (simple data binding).

A non-repeating schema element is one in which the maxOccurs attribute equals one.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

AddIndent

Gets or sets a value that indicates whether text is automatically indented when the text alignment in the XmlMappedRange control is set to equal distribution either horizontally or vertically.

Address

Gets the range reference of the XmlMappedRange control.

AddressLocal

Gets the range reference of the XmlMappedRange control in the language of the user.

AllowEdit

Gets a value that indicates whether the XmlMappedRange control can be edited on a protected worksheet.

Application

Gets a Application that represents the Microsoft Office Excel application.

Borders

Gets a Borders collection that represents the borders of an XmlMappedRange control.

Cells

Gets a Range that represents the cells in the XmlMappedRange control.

Characters

Gets a Characters object that represents a range of characters within the text of the XmlMappedRange control.

Column

Gets the number of the column in the XmlMappedRange control.

Columns
ColumnWidth

Gets or sets the width of the column in the XmlMappedRange control.

Comment

Gets a Comment that represents the comment associated with the cell in the upper-left corner of the XmlMappedRange control.

Container
Count

Gets the number of objects in the XmlMappedRange control.

CountLarge

Gets a value that represents the number of times that the largest value in a range appears.

Creator

Gets a value that indicates the application in which this XmlMappedRange control was created.

CurrentArray

If the XmlMappedRange is part of an array, gets a Range that represents the entire array.

CurrentRegion

Gets a Range that represents the current region.

Dependents

Gets a Range that represents the range containing all the dependents of the XmlMappedRange control.

DirectDependents

Gets a Range that represents the range containing all the direct dependents of an XmlMappedRange control.

DirectPrecedents

Gets a Range that represents the range containing all the direct precedents of an XmlMappedRange control.

DisplayFormat

Gets an object that represents the display settings for the specified range.

End

Gets a Range that represents the cell at the end of the region that contains the XmlMappedRange control.

EntireColumn

Gets a Range that represents the entire column that contains the XmlMappedRange control.

EntireRow

Gets a Range that represents the row that contains the XmlMappedRange control.

Errors

Gets an Errors object that enables you to access error checking options of an XmlMappedRange control.

Font

Gets a Font that represents the font of the XmlMappedRange control.

FormatConditions

Gets a FormatConditions collection that represents all the conditional formats for the XmlMappedRange control.

Formula

Gets or sets the formula of an XmlMappedRange control in A1-style notation.

FormulaArray

Gets or sets the array formula of an XmlMappedRange control.

FormulaHidden

Gets or sets a value that indicates whether the formula in the XmlMappedRange control is hidden when the worksheet is protected.

FormulaLocal

Gets or sets the formula for the XmlMappedRange control, using A1-style references in the language of the user.

FormulaR1C1

Gets or sets the formula for the XmlMappedRange control, using R1C1-style notation.

FormulaR1C1Local

Gets or sets the formula for the XmlMappedRange control, using R1C1-style notation in the language of the user.

HasArray

Gets a value that indicates whether the XmlMappedRange control is part of an array formula.

HasFormula

Gets a value that indicates whether the XmlMappedRange control contains a formula.

Height

Gets the height, in points, of the XmlMappedRange control.

HorizontalAlignment

Gets or sets the horizontal alignment for the XmlMappedRange control.

Hyperlinks

Gets a Hyperlinks collection that represents the hyperlinks for the XmlMappedRange control.

ID

Gets or sets the identifying label for the XmlMappedRange control when the page is saved as a Web page.

IndentLevel

Gets or sets the indent level for the XmlMappedRange control.

InnerObject

Gets a Range that represents the underlying native object for the XmlMappedRange.

Interior

Gets an Interior that represents the interior of the XmlMappedRange control.

Item

Gets a Range that represents a range at an offset to the XmlMappedRange control.

Left

Gets a value that represents the distance from the left edge of column A to the left edge of the XmlMappedRange control.

ListObject

Gets a ListObject for the XmlMappedRange control.

LocationInTable

Gets a constant that describes the part of the PivotTable report that contains the upper-left corner of the XmlMappedRange control.

Locked

Gets or sets a value that indicates whether the XmlMappedRange control is locked.

MDX

Gets an MDX expression that describes the XmlMappedRange.

MergeArea

Gets a Range that represents the merged range containing the XmlMappedRange control.

MergeCells

Gets or sets a value that indicates whether the XmlMappedRange control contains merged cells.

Name

Gets or sets a value representing a defined name for an XmlMappedRange control.

Next

Gets a Range that represents the next cell.

NumberFormat

Gets or sets the format code for the XmlMappedRange control.

NumberFormatLocal

Gets or sets the format code for the XmlMappedRange control in the language of the user.

Offset

Gets a Range that is offset from the XmlMappedRange control.

Orientation

Gets or sets a value that specifies the text orientation.

OutlineLevel

Gets or sets the current outline level of the XmlMappedRange.

PageBreak

Gets or sets the location of a page break.

Parent

Gets a Worksheet that represents the worksheet containing the XmlMappedRange control.

Phonetic

Gets the Phonetic object which contains information about a specific phonetic text string in the XmlMappedRange control.

Phonetics

Gets the Phonetics collection of the XmlMappedRange control.

PivotCell

Gets a PivotCell that represents a cell in a PivotTable report.

PivotField

Gets a PivotField that represents the PivotTable field containing the upper-left corner of the XmlMappedRange control.

PivotItem

Gets a PivotItem that represents the PivotTable item containing the upper-left corner of the XmlMappedRange control.

PivotTable

Gets a PivotTable that represents the PivotTable report containing the upper-left corner of the XmlMappedRange control, or the PivotTable report associated with the PivotChart report.

Precedents

Gets a Range that represents all the precedents of the XmlMappedRange control.

PrefixCharacter

Gets the prefix character for the XmlMappedRange control.

Previous

Gets a Range that represents the previous cell.

QueryTable

Gets a QueryTable that represents the query table that intersects the XmlMappedRange control.

ReadingOrder

Gets or sets the reading order for the XmlMappedRange control.

Resize

Gets a resized Range based on the XmlMappedRange control.

Row

Gets the number of the row that contains the XmlMappedRange control.

RowHeight

Gets or sets the height of the row that contains the XmlMappedRange control, measured in points.

Rows

Gets a Range that represents the row that contains the XmlMappedRange control.

ServerActions

Gets the actions that can be performed on the SharePoint server for an XmlMappedRange object.

ShowDetail

Gets or sets an object that indicates whether the outline is expanded for the XmlMappedRange control (so that the detail of the column or row is visible).

ShrinkToFit

Gets or sets a value that indicates whether text automatically shrinks to fit in the available column width.

SoundNote
SparklineGroups

Gets an object that represents an existing group of sparklines from the specified range.

Style

Gets or sets a Style that represents the style of the XmlMappedRange control.

Summary

Gets a value that indicates whether the XmlMappedRange is an outlining summary row or column.

Tag

Gets or sets the object that contains data about the Tag control.

Text

Gets the text for the XmlMappedRange control.

Top

Gets the distance, in points, from the top of row 1 to the top edge of the XmlMappedRange control.

UseStandardHeight

Gets or sets a value that indicates whether the row height of the XmlMappedRange control equals the standard height of the sheet.

UseStandardWidth

Gets or sets a value that indicates whether the column width of the XmlMappedRange control equals the standard width of the sheet.

Validation

Gets the Validation object that represents data validation for the XmlMappedRange control.

Value

Gets or sets the value of the XmlMappedRange control.

Value2

Gets or sets the XmlMappedRange control value.

VerticalAlignment

Gets or sets the vertical alignment of the XmlMappedRange control.

Width

Gets the width of the XmlMappedRange control in points.

Worksheet

Gets a Worksheet that represents the worksheet containing the XmlMappedRange control.

WrapText

Gets or sets a value that indicates whether Microsoft Office Excel wraps the text in the XmlMappedRange control.

XPath

Gets an XPath that represents the XPath of the element mapped to the XmlMappedRange control.

Methods

Activate()

Activates a single cell XmlMappedRange control.

AddComment(Object)

Adds a comment to the XmlMappedRange control.

AllocateChanges()

Performs a writeback operation for all edited cells in an XML mapped range based on an OLAP data source.

AutoComplete(String)

Gets an AutoComplete match from the list.

AutoFilter(Object, Object, XlAutoFilterOperator, Object, Object)

Filters a list using the AutoFilter.

AutoOutline()

Automatically creates an outline for the XmlMappedRange control.

BorderAround2(Object, XlBorderWeight, XlColorIndex, Object, Object)

Adds a border to a XmlMappedRange control and sets the Color, LineStyle, and Weight properties for the new border.

Calculate()

Calculates the value of the XmlMappedRange control.

CalculateRowMajorOrder()

Calculates the value in each item in the range in row-major order.

CheckSpelling(Object, Object, Object, Object)

Checks the spelling of text in the XmlMappedRange control.

Clear()

Clears the entire XmlMappedRange control.

ClearComments()

Clears all cell comments from the XmlMappedRange control.

ClearContents()

Clears the formulas from the XmlMappedRange control.

ClearFormats()

Clears the formatting of the XmlMappedRange control.

ClearHyperlinks()

Removes all hyperlinks from the specified range.

ClearNotes()

Clears notes and sound notes from the XmlMappedRange control.

ClearOutline()

Clears the outline for the XmlMappedRange control.

ColumnDifferences(Object)

Gets a Range that represents all the cells whose contents are different from the comparison cell in each column.

Consolidate(Object, Object, Object, Object, Object)

Consolidates data from multiple ranges on multiple worksheets into an XmlMappedRange control.

Copy(Object)

Copies the contents of the XmlMappedRange control to the specified range or to the Clipboard.

CopyFromRecordset(Object, Object, Object)

Copies the contents of an ADO or DAO recordset onto a worksheet, beginning at the XmlMappedRange control.

CopyPicture(XlPictureAppearance, XlCopyPictureFormat)

Copies the XmlMappedRange control to the Clipboard as a picture.

CreateNames(Object, Object, Object, Object)

Creates names in the XmlMappedRange control, based on text labels in the worksheet.

Cut(Object)

Cuts the contents of the XmlMappedRange control to the Clipboard or pastes it into a specified destination.

DataSeries(Object, XlDataSeriesType, XlDataSeriesDate, Object, Object, Object)

Creates a data series in the XmlMappedRange control.

DialogBox()

Displays a dialog box defined by a dialog box definition table on a Microsoft Office Excel 4.0 macro sheet.

Dirty()

Designates an XmlMappedRange control to be recalculated when the next recalculation occurs.

DiscardChanges()

Discards all changes in the edited cells of the Xml mapped range.

EditionOptions(XlEditionType, XlEditionOptionsOption, Object, Object, XlPictureAppearance, XlPictureAppearance, Object)
ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)

Exports to a file of the specified format.

FillDown()

Fills down from the top cell in the XmlMappedRange control to the bottom of the XmlMappedRange control.

FillLeft()

Fills left from the rightmost cell in the XmlMappedRange control.

FillRight()

Fills right from the leftmost cell in the XmlMappedRange control.

FillUp()

Fills up from the bottom cell in the specified range to the top of the XmlMappedRange control.

Find(Object, Object, Object, Object, Object, XlSearchDirection, Object, Object, Object)

Finds specific information in an XmlMappedRange control, and returns a Range that represents the first cell where that information is found.

FindNext(Object)

Continues a search that was begun with the Find(Object, Object, Object, Object, Object, XlSearchDirection, Object, Object, Object) method.

FindPrevious(Object)

Continues a search that was begun with the Find(Object, Object, Object, Object, Object, XlSearchDirection, Object, Object, Object) method.

FunctionWizard()

Starts the Function Wizard for the XmlMappedRange control.

GetEnumerator()

Gets an enumerator that can be used to iterate over an XmlMappedRange control.

Group(Object, Object, Object, Object)

When the XmlMappedRange control represents a single cell in the data range of a PivotTable field, the Group(Object, Object, Object, Object) method performs numeric or date-based grouping in that field.

Insert(Object, Object)

Inserts a cell into the XmlMappedRange control and shifts other cells away to make space.

InsertIndent(Int32)

Adds an indent to the XmlMappedRange control.

Justify()

Rearranges the text in an XmlMappedRange control so that it fills the range evenly.

ListNames()

Pastes a list of all displayed names onto the worksheet, beginning with the XmlMappedRange control.

Merge(Object)

Creates a merged cell from the XmlMappedRange control.

NavigateArrow(Object, Object, Object)

Navigates a tracer arrow for the XmlMappedRange control to the precedent, dependent, or error-causing cell or cells.

NoteText(Object, Object, Object)

Gets or sets the cell note associated with the XmlMappedRange control.

Parse(Object, Object)

Parses a range of data and breaks it into multiple cells

PasteSpecial(XlPasteType, XlPasteSpecialOperation, Object, Object)

Pastes the contents of a Range from the Clipboard into the XmlMappedRange control.

PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object)

Prints out the XmlMappedRange.

PrintPreview(Object)

Shows a preview of the XmlMappedRange control as it would look when printed.

RemoveDuplicates(Object, XlYesNoGuess)

Removes duplicate values from a range of values.

RemoveSubtotal()

Removes subtotals from an XmlMappedRange control.

Replace(Object, Object, Object, Object, Object, Object, Object, Object)

Replaces the specified characters in the XmlMappedRange control with a new string.

RowDifferences(Object)

Gets a Range that represents the cells whose contents are different from those of the comparison cell in each row.

Select()

Selects the XmlMappedRange control.

SetPhonetic()

Creates Phonetic objects for the XmlMappedRange control.

Show()

Scrolls through the contents of the active window to move the XmlMappedRange control into view.

ShowDependents(Object)

Draws tracer arrows to the direct dependents of the XmlMappedRange control.

ShowErrors()

Draws tracer arrows through the precedents tree to the cell that is the source of the error, and returns the range that contains that cell.

ShowPrecedents(Object)

Draws tracer arrows to the direct precedents of the XmlMappedRange control.

Speak(Object, Object)

Causes the cells of the XmlMappedRange control to be spoken in row order or column order.

SpecialCells(XlCellType, Object)

Gets a Range that represents all the cells that match the specified type and value.

SubscribeTo(String, XlSubscribeToFormat)
Subtotal(Int32, XlConsolidationFunction, Object, Object, Object, XlSummaryRow)

Creates subtotals for the XmlMappedRange control.

Table(Object, Object)

Creates a data table based on input values and formulas that you define on a worksheet.

TextToColumns(Object, XlTextParsingType, XlTextQualifier, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Parses a column of cells that contain text into several columns.

Ungroup()

Promotes an XmlMappedRange control in an outline (that is, decreases its outline level).

UnMerge()

Separates a merged area into individual cells.

Events

BeforeDoubleClick

Occurs when an XmlMappedRange control is double-clicked, before the default double-click action.

BeforeRightClick

Occurs when an XmlMappedRange control is right-clicked, before the default right-click action.

BindingContextChanged
Change

Occurs when something changes in the XmlMappedRange control.

Deselected

Occurs when selection moves from the XmlMappedRange control to an area outside of the XmlMappedRange control.

Selected

Occurs when the XmlMappedRange control is selected.

SelectionChange

Occurs when the selection inside the XmlMappedRange control changes.

Applies to