XmlMappedRange Interface

  • Article

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

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
<GuidAttribute("ac172e76-a2b5-4fcc-ae02-65ce23f50cb3")> _
Public Interface XmlMappedRange _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize

[GuidAttribute("ac172e76-a2b5-4fcc-ae02-65ce23f50cb3")]
public interface XmlMappedRange : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The XmlMappedRange type exposes the following members.

Properties

  Name Description
Public property 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.
Public property Address Gets the range reference of the XmlMappedRange control.
Public property AddressLocal Gets the range reference of the XmlMappedRange control in the language of the user.
Public property AllowEdit Gets a value that indicates whether the XmlMappedRange control can be edited on a protected worksheet.
Public property Application Gets a Microsoft.Office.Interop.Excel.Application that represents the Microsoft Office Excel application.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property Borders Gets a Microsoft.Office.Interop.Excel.Borders collection that represents the borders of an XmlMappedRange control.
Public property Cells Gets a Range that represents the cells in the XmlMappedRange control.
Public property Characters Gets a Microsoft.Office.Interop.Excel.Characters object that represents a range of characters within the text of the XmlMappedRange control.
Public property Column Gets the number of the column in the XmlMappedRange control.
Public property Columns Infrastructure.
Public property ColumnWidth Gets or sets the width of the column in the XmlMappedRange control.
Public property Comment Gets a Comment that represents the comment associated with the cell in the upper-left corner of the XmlMappedRange control.
Public property Container Infrastructure.
Public property Count Gets the number of objects in the XmlMappedRange control.
Public property CountLarge Gets a value that represents the number of times that the largest value in a range appears.
Public property Creator Gets a value that indicates the application in which this XmlMappedRange control was created.
Public property CurrentArray If the XmlMappedRange is part of an array, gets a Range that represents the entire array.
Public property CurrentRegion Gets a Range that represents the current region.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property Dependents Gets a Range that represents the range containing all the dependents of the XmlMappedRange control.
Public property DirectDependents Gets a Range that represents the range containing all the direct dependents of an XmlMappedRange control.
Public property DirectPrecedents Gets a Range that represents the range containing all the direct precedents of an XmlMappedRange control.
Public property DisplayFormat Gets an object that represents the display settings for the specified range.
Public property End Gets a Range that represents the cell at the end of the region that contains the XmlMappedRange control.
Public property EntireColumn Gets a Range that represents the entire column that contains the XmlMappedRange control.
Public property EntireRow Gets a Range that represents the row that contains the XmlMappedRange control.
Public property Errors Gets an Errors object that enables you to access error checking options of an XmlMappedRange control.
Public property Font Gets a Microsoft.Office.Interop.Excel.Font that represents the font of the XmlMappedRange control.
Public property FormatConditions Gets a FormatConditions collection that represents all the conditional formats for the XmlMappedRange control.
Public property Formula Gets or sets the formula of an XmlMappedRange control in A1-style notation.
Public property FormulaArray Gets or sets the array formula of an XmlMappedRange control.
Public property FormulaHidden Gets or sets a value that indicates whether the formula in the XmlMappedRange control is hidden when the worksheet is protected.
Public property FormulaLabel Gets or sets the formula label type for the XmlMappedRange control.
Public property FormulaLocal Gets or sets the formula for the XmlMappedRange control, using A1-style references in the language of the user.
Public property FormulaR1C1 Gets or sets the formula for the XmlMappedRange control, using R1C1-style notation.
Public property FormulaR1C1Local Gets or sets the formula for the XmlMappedRange control, using R1C1-style notation in the language of the user.
Public property HasArray Gets a value that indicates whether the XmlMappedRange control is part of an array formula.
Public property HasFormula Gets a value that indicates whether the XmlMappedRange control contains a formula.
Public property Height Gets the height, in points, of the XmlMappedRange control.
Public property Hidden Infrastructure.
Public property HorizontalAlignment Gets or sets the horizontal alignment for the XmlMappedRange control.
Public property Hyperlinks Gets a Hyperlinks collection that represents the hyperlinks for the XmlMappedRange control.
Public property ID Gets or sets the identifying label for the XmlMappedRange control when the page is saved as a Web page.
Public property IndentLevel Gets or sets the indent level for the XmlMappedRange control.
Public property InnerObject Gets a Microsoft.Office.Interop.Excel.Range that represents the underlying native object for the XmlMappedRange.
Public property Interior Gets an Microsoft.Office.Interop.Excel.Interior that represents the interior of the XmlMappedRange control.
Public property Item Gets a Range that represents a range at an offset to the XmlMappedRange control.
Public property Left Gets a value that represents the distance from the left edge of column A to the left edge of the XmlMappedRange control.
Public property ListHeaderRows Infrastructure.
Public property ListObject Gets a Microsoft.Office.Interop.Excel.ListObject for the XmlMappedRange control.
Public property LocationInTable Gets a constant that describes the part of the PivotTable report that contains the upper-left corner of the XmlMappedRange control.
Public property Locked Gets or sets a value that indicates whether the XmlMappedRange control is locked.
Public property MDX Gets an MDX expression that describes the XmlMappedRange.
Public property MergeArea Gets a Range that represents the merged range containing the XmlMappedRange control.
Public property MergeCells Gets or sets a value that indicates whether the XmlMappedRange control contains merged cells.
Public property Name Gets or sets a value representing a defined name for an XmlMappedRange control.
Public property Next Gets a Range that represents the next cell.
Public property NumberFormat Gets or sets the format code for the XmlMappedRange control.
Public property NumberFormatLocal Gets or sets the format code for the XmlMappedRange control in the language of the user.
Public property Offset Gets a Range that is offset from the XmlMappedRange control.
Public property Orientation Gets or sets a value that specifies the text orientation.
Public property OutlineLevel Gets or sets the current outline level of the XmlMappedRange.
Public property PageBreak Gets or sets the location of a page break.
Public property Parent Gets a Microsoft.Office.Interop.Excel.Worksheet that represents the worksheet containing the XmlMappedRange control.
Public property Phonetic Gets the Phonetic object which contains information about a specific phonetic text string in the XmlMappedRange control.
Public property Phonetics Gets the Phonetics collection of the XmlMappedRange control.
Public property PivotCell Gets a PivotCell that represents a cell in a PivotTable report.
Public property PivotField Gets a PivotField that represents the PivotTable field containing the upper-left corner of the XmlMappedRange control.
Public property PivotItem Gets a PivotItem that represents the PivotTable item containing the upper-left corner of the XmlMappedRange control.
Public property 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.
Public property Precedents Gets a Range that represents all the precedents of the XmlMappedRange control.
Public property PrefixCharacter Gets the prefix character for the XmlMappedRange control.
Public property Previous Gets a Range that represents the previous cell.
Public property QueryTable Gets a Microsoft.Office.Interop.Excel.QueryTable that represents the query table that intersects the XmlMappedRange control.
Public property ReadingOrder Gets or sets the reading order for the XmlMappedRange control.
Public property Resize Gets a resized Range based on the XmlMappedRange control.
Public property Row Gets the number of the row that contains the XmlMappedRange control.
Public property RowHeight Gets or sets the height of the row that contains the XmlMappedRange control, measured in points.
Public property Rows Gets a Range that represents the row that contains the XmlMappedRange control.
Public property ServerActions Gets the actions that can be performed on the SharePoint server for an XmlMappedRange object.
Public property 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).
Public property ShrinkToFit Gets or sets a value that indicates whether text automatically shrinks to fit in the available column width.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property SmartTags Gets a Microsoft.Office.Interop.Excel.SmartTags object representing the identifier for the XmlMappedRange control.
Public property SoundNote Infrastructure.
Public property SparklineGroups Gets an object that represents an existing group of sparklines from the specified range.
Public property Style Gets or sets a Microsoft.Office.Interop.Excel.Style that represents the style of the XmlMappedRange control.
Public property Summary Gets a value that indicates whether the XmlMappedRange is an outlining summary row or column.
Public property Tag Gets or sets the object that contains data about the Tag control.
Public property Text Gets the text for the XmlMappedRange control.
Public property Top Gets the distance, in points, from the top of row 1 to the top edge of the XmlMappedRange control.
Public property UseStandardHeight Gets or sets a value that indicates whether the row height of the XmlMappedRange control equals the standard height of the sheet.
Public property UseStandardWidth Gets or sets a value that indicates whether the column width of the XmlMappedRange control equals the standard width of the sheet.
Public property Validation Gets the Microsoft.Office.Interop.Excel.Validation object that represents data validation for the XmlMappedRange control.
Public property Value Gets or sets the value of the XmlMappedRange control.
Public property Value2 Gets or sets the XmlMappedRange control value.
Public property VerticalAlignment Gets or sets the vertical alignment of the XmlMappedRange control.
Public property Width Gets the width of the XmlMappedRange control in points.
Public property Worksheet Gets a Microsoft.Office.Interop.Excel.Worksheet that represents the worksheet containing the XmlMappedRange control.
Public property WrapText Gets or sets a value that indicates whether Microsoft Office Excel wraps the text in the XmlMappedRange control.
Public property XPath Gets an Microsoft.Office.Interop.Excel.XPath that represents the XPath of the element mapped to the XmlMappedRange control.

Top

Methods

  Name Description
Public method _PasteSpecial Infrastructure.
Public method _PrintOut Infrastructure.
Public method Activate Activates a single cell XmlMappedRange control.
Public method AddComment Adds a comment to the XmlMappedRange control.
Public method AllocateChanges Performs a writeback operation for all edited cells in an XML mapped range based on an OLAP data source. This method can be used only in Excel 2010 projects.
Public method AutoComplete Gets an AutoComplete match from the list.
Public method AutoFilter Filters a list using the AutoFilter.
Public method AutoOutline Automatically creates an outline for the XmlMappedRange control.
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method BorderAround Adds a border to an XmlMappedRange control and sets the Color, LineStyle, and Weight properties for the new border.
Public method BorderAround2 Adds a border to a XmlMappedRange control and sets the Color, LineStyle, and Weight properties for the new border.
Public method Calculate Calculates the value of the XmlMappedRange control.
Public method CalculateRowMajorOrder Calculates the value in each item in the range in row-major order.
Public method CheckSpelling Checks the spelling of text in the XmlMappedRange control.
Public method Clear Clears the entire XmlMappedRange control.
Public method ClearComments Clears all cell comments from the XmlMappedRange control.
Public method ClearContents Clears the formulas from the XmlMappedRange control.
Public method ClearFormats Clears the formatting of the XmlMappedRange control.
Public method ClearHyperlinks Removes all hyperlinks from the specified range.
Public method ClearNotes Clears notes and sound notes from the XmlMappedRange control.
Public method ClearOutline Clears the outline for the XmlMappedRange control.
Public method ColumnDifferences Gets a Range that represents all the cells whose contents are different from the comparison cell in each column.
Public method Consolidate Consolidates data from multiple ranges on multiple worksheets into an XmlMappedRange control.
Public method Copy Copies the contents of the XmlMappedRange control to the specified range or to the Clipboard.
Public method CopyFromRecordset Copies the contents of an ADO or DAO recordset onto a worksheet, beginning at the XmlMappedRange control.
Public method CopyPicture Copies the XmlMappedRange control to the Clipboard as a picture.
Public method CreateNames Creates names in the XmlMappedRange control, based on text labels in the worksheet.
Public method CreatePublisher Infrastructure.
Public method Cut Cuts the contents of the XmlMappedRange control to the Clipboard or pastes it into a specified destination.
Public method DataSeries Creates a data series in the XmlMappedRange control.
Public method DialogBox Displays a dialog box defined by a dialog box definition table on a Microsoft Office Excel 4.0 macro sheet.
Public method Dirty Designates an XmlMappedRange control to be recalculated when the next recalculation occurs.
Public method DiscardChanges Discards all changes in the edited cells of the Xml mapped range. This method can be used only in Excel 2010 projects.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EditionOptions Infrastructure.
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method ExportAsFixedFormat Exports to a file of the specified format.
Public method FillDown Fills down from the top cell in the XmlMappedRange control to the bottom of the XmlMappedRange control.
Public method FillLeft Fills left from the rightmost cell in the XmlMappedRange control.
Public method FillRight Fills right from the leftmost cell in the XmlMappedRange control.
Public method FillUp Fills up from the bottom cell in the specified range to the top of the XmlMappedRange control.
Public method Find Finds specific information in an XmlMappedRange control, and returns a Range that represents the first cell where that information is found.
Public method FindNext Continues a search that was begun with the Find method.
Public method FindPrevious Continues a search that was begun with the Find method.
Public method FunctionWizard Starts the Function Wizard for the XmlMappedRange control.
Public method get_Address Infrastructure.
Public method get_AddressLocal Infrastructure.
Public method get_Characters Infrastructure.
Public method get_End Infrastructure.
Public method get_Item Infrastructure.
Public method get_Offset Infrastructure.
Public method get_Range Infrastructure.
Public method get_Resize Infrastructure.
Public method get_Value Infrastructure.
Public method GetEnumerator Gets an enumerator that can be used to iterate over an XmlMappedRange control.
Public method GoalSeek Calculates the values necessary to achieve a specific goal.
Public method Group When the XmlMappedRange control represents a single cell in the data range of a PivotTable field, the Group method performs numeric or date-based grouping in that field.
Public method Insert Inserts a cell into the XmlMappedRange control and shifts other cells away to make space.
Public method InsertIndent Adds an indent to the XmlMappedRange control.
Public method Justify Rearranges the text in an XmlMappedRange control so that it fills the range evenly.
Public method ListNames Pastes a list of all displayed names onto the worksheet, beginning with the XmlMappedRange control.
Public method Merge Creates a merged cell from the XmlMappedRange control.
Public method NavigateArrow Navigates a tracer arrow for the XmlMappedRange control to the precedent, dependent, or error-causing cell or cells.
Public method NoteText Gets or sets the cell note associated with the XmlMappedRange control.
Public method Parse Parses a range of data and breaks it into multiple cells
Public method PasteSpecial Pastes the contents of a Range from the Clipboard into the XmlMappedRange control.
Public method PrintOut Prints the XmlMappedRange control.
Public method PrintOutEx Prints out the XmlMappedRange.
Public method PrintPreview Shows a preview of the XmlMappedRange control as it would look when printed.
Public method RemoveDuplicates Removes duplicate values from a range of values.
Public method RemoveSubtotal Removes subtotals from an XmlMappedRange control.
Public method Replace Replaces the specified characters in the XmlMappedRange control with a new string.
Public method RowDifferences Gets a Range that represents the cells whose contents are different from those of the comparison cell in each row.
Public method Run Infrastructure.
Public method Select Selects the XmlMappedRange control.
Public method set_Item Infrastructure.
Public method set_Value Infrastructure.
Public method SetPhonetic Creates Phonetic objects for the XmlMappedRange control.
Public method Show Scrolls through the contents of the active window to move the XmlMappedRange control into view.
Public method ShowDependents Draws tracer arrows to the direct dependents of the XmlMappedRange control.
Public method 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.
Public method ShowPrecedents Draws tracer arrows to the direct precedents of the XmlMappedRange control.
Public method Speak Causes the cells of the XmlMappedRange control to be spoken in row order or column order.
Public method SpecialCells Gets a Range that represents all the cells that match the specified type and value.
Public method SubscribeTo Infrastructure.
Public method Subtotal Creates subtotals for the XmlMappedRange control.
Public method Table Creates a data table based on input values and formulas that you define on a worksheet.
Public method TextToColumns Parses a column of cells that contain text into several columns.
Public method Ungroup Promotes an XmlMappedRange control in an outline (that is, decreases its outline level).
Public method UnMerge Separates a merged area into individual cells.

Top

Events

  Name Description
Public event BeforeDoubleClick Occurs when an XmlMappedRange control is double-clicked, before the default double-click action.
Public event BeforeRightClick Occurs when an XmlMappedRange control is right-clicked, before the default right-click action.
Public event BindingContextChanged Infrastructure.
Public event Change Occurs when something changes in the XmlMappedRange control.
Public event Deselected Occurs when selection moves from the XmlMappedRange control to an area outside of the XmlMappedRange control.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event Selected Occurs when the XmlMappedRange control is selected.
Public event SelectionChange Occurs when the selection inside the XmlMappedRange control changes.

Top

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. 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: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace