This documentation is archived and is not being maintained.

RevisionDefinedName Class

Revision Defined Name.When the object is serialized out as xml, its qualified name is x:rdn.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.RevisionDefinedName

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[ChildElementInfoAttribute(typeof(Formula))]
[ChildElementInfoAttribute(typeof(ExtensionList))]
[ChildElementInfoAttribute(typeof(OldFormula))]
public class RevisionDefinedName : OpenXmlCompositeElement

The following table lists the possible child types:

  • Formula <x:formula>

  • OldFormula <x:oldFormula>

  • ExtensionList <x:extLst>


[ISO/IEC 29500-1 1st Edition]

18.11.1.13 rdn (Revision Defined Name)

This element represents a revision record of a defined name change.

Parent Elements

revisions (§18.11.1.16)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

formula (Formula)

§18.3.1.43

oldFormula (Old Formula)

§18.11.1.7

Attributes

Description

comment (Name Comment)

A string representing a comment about the defined name.

This comment can be shown by the spreadsheet application in a names management UI so that users have more information about what the defined name is used for.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

customMenu (New Custom Menu)

A string representing the new custom menu text

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

customView (Custom View)

A Boolean flag indicating that this named range belongs to a custom view

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

description (Description)

A string representing the new description text for the defined name.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

function (Function)

A Boolean value indicating that the defined name refers to a function. True if the defined name is a function, false otherwise.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

functionGroupId (Function Group Id)

Represents the new function group id.

Function group ids are used to help classify functions. For instance, functions in the same group can be searched or selected easily from the spreadsheet applications UI. For instance, filtering the list of all functions to allow the user to choose from functions used for financial data.

The following group ids should be used:

ID Function group

1 Financial

2 Date and Time

3 Math and Trig

4 Statistical

5 Lookup & Reference

6 Database

7 Text

8 Logical

9 Information

10 Commands

11 Customizing

12 Macro Control

13 DDE/External

14 User Defined

15 Engineering

14 Cube

The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.

help (New Help Topic)

A string representing the new help topic text.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

hidden (Named Range Hidden)

A Boolean value indicating whether the named range is now hidden.

Hidden refers to whether the defined name is of a 'hidden' type. This applies to things like a custom filter on a cell, it has a name, but is hidden and so is not visible in any name management UI.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

localSheetId (Local Name Sheet Id)

An integer representing the id of the sheet to which this defined name belongs. This shall be used local defined names only.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

name (Name)

A string representing the name for this defined name.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

oldComment (Old Name Comment)

A string representing the old comment about the defined name.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

oldCustomMenu (Old Custom Menu Text)

A string representing the old custom menu text

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

oldDescription (Old Description)

A string representing the old description text

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

oldFunction (Old Function)

A Boolean flag indicating that the old name was a function

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

oldFunctionGroupId (Old Function Group Id)

Old function group ID.

The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.

oldHelp (Old Help Topic)

A string representing the old help topic text

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

oldHidden (Old Hidden)

A Boolean flag indicating whether the named range was hidden

Hidden refers to whether the defined name is of a 'hidden' type. This applies to things like a custom filter on a cell, it has a name, but is hidden and so is not visible in any name management UI.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

oldShortcutKey (Old Short Cut Key)

Old keyboard shortcut.

The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.

oldStatusBar (Old Status Bar)

A string representing the old status bar text

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

ra (Revision Undo Rejected)

A Boolean flag which indicates that this revision was due to a previous undo (ua) revision being rejected.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

rId (Revision Id)

An integer representing the number of this revision. This id shall apply to reviewable revision types only.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

shortcutKey (Shortcut Key)

Represents the new keyboard shortcut.

The possible values for this attribute are defined by the W3C XML Schema unsignedByte datatype.

statusBar (Status Bar)

A string representing the new status bar text.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

ua (Revision From Rejection)

A Boolean flag indicating that this revision occurred because another revision was rejected and therefore undone.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_RevisionDefinedName) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: