SPFieldRatingScale members

Represents a rating scale field that is used in surveys.

The SPFieldRatingScale type exposes the following members.

Properties

	Name	Description
	AggregationFunction	Gets or sets the aggregation function for the field. (Inherited from SPField.)
	AllowDeletion	Gets or sets a Boolean value that specifies whether the field can be deleted. (Inherited from SPField.)
	AuthoringInfo	Gets the descriptive string that is used in pages for editing fields to identify the field and its purpose. (Inherited from SPField.)
	CalloutMenu	Gets or sets an indication of whether the field shows a link to the callout menu. (Inherited from SPField.)
	CalloutMenuAllowed	Gets or sets an indication of whether showing the callout menu in the field is allowed, prohibited, or is optional and determined by the CalloutMenu property. (Inherited from SPField.)
	CanBeDeleted	Gets a Boolean value that indicates whether the field can be deleted. (Inherited from SPField.)
	CanBeDisplayedInEditForm	A read-only property indicating whether or not the field can be displayed in an edit form. (Inherited from SPField.)
	CanToggleHidden	Gets a Boolean value that indicates whether the column can be hidden through the user interface. (Inherited from SPField.)
	Choices	Gets the choices that are used in the multichoice field. (Inherited from SPFieldMultiChoice.)
	CompositeIndexable	Indicates whether and in what capacity the field can participate in a composite index. (Inherited from SPField.)
	DefaultFormula	Gets or sets the default formula for a calculated field. (Inherited from SPField.)
	DefaultListField	Gets a value that indicates whether to show the properties form of a file when it is uploaded to a document library. (Inherited from SPField.)
	DefaultValue	Gets or sets the default value for a field. (Inherited from SPField.)
	DefaultValueTyped	Gets the default value object based on the field type. (Inherited from SPField.)
	Description	Gets or sets the description for a field. (Inherited from SPField.)
	DescriptionResource	Gets an SPUserResource object that represents the translations for the description of the field. (Inherited from SPField.)
	Direction	Gets or sets the direction of the reading order for the field. (Inherited from SPField.)
	DisplaySize	Gets or sets the display size for the field. (Inherited from SPField.)
	EnforceUniqueValues	Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false. (Inherited from SPField.)
	EntityPropertyName	Gets the name of the entity property for the list item entity that uses this field. (Inherited from SPField.)
	FieldReferences	Gets a string array that contains the internal names of fields that are referenced in a computed field. (Inherited from SPField.)
	FieldRenderingControl	Gets the field type control that is used to render the field. (Overrides SPFieldMultiChoice.FieldRenderingControl.)
	FieldRenderingMobileControl	Obsolete. Gets the mobile field type control that is used to render the field. (Inherited from SPFieldMultiChoice.)
	FieldRenderingMobileWebControl	Gets the mobile field type control that is used to render the field in Display, Edit, and New forms, data form Web Parts, or any pages that use field controls. (Inherited from SPFieldMultiChoice.)
	FieldTypeDefinition	Gets an SPFieldTypeDefinition object that represents the field type definition for the field. (Inherited from SPField.)
	FieldValueType	Gets the value type of the field when the field type has its own value type. (Overrides SPFieldMultiChoice.FieldValueType.)
	FillInChoice	Gets or sets a Boolean value that determines whether a text box for typing an alternative value is provided for the multichoice field. (Inherited from SPFieldMultiChoice.)
	Filterable	Gets a Boolean value that indicates whether the rating-scale field can be filtered. (Overrides SPField.Filterable.)
	FilterableNoRecurrence	Gets a Boolean value that indicates whether a filter can be created on a field in a view that does not expand recurring events. (Inherited from SPField.)
	FromBaseType	Gets a Boolean value that indicates whether the field derives from a base field type. (Inherited from SPField.)
	GridEndNumber	Gets or sets the end number for the rating scale.
	GridNAOptionText	Gets or sets the text to display for the Not Applicable (N/A) option.
	GridStartNumber	Gets or sets the start number for the rating scale.
	GridTextRangeAverage	Gets or sets the text to display for average ratings.
	GridTextRangeHigh	Gets or sets the text to display for high ratings.
	GridTextRangeLow	Gets or sets the text to display for low ratings.
	Group	Gets or sets the column group to which the field belongs. (Inherited from SPField.)
	Hidden	Gets or sets a Boolean value that specifies whether the field is displayed in the list. (Inherited from SPField.)
	Id	Gets the GUID of the field. (Inherited from SPField.)
	IMEMode	Gets or sets the Input Method Editor (IME) mode bias to use for the field. The IME enables conversion of keystrokes between languages when one writing system has more characters than can be encoded for the given keyboard. (Inherited from SPField.)
	Indexable	Read-only property indicating whether the field can be indexed or not. (Inherited from SPField.)
	Indexed	Gets or sets a Boolean value that specifies whether the field is indexed. (Inherited from SPField.)
	InternalName	Gets the internal name that is used for the field. (Inherited from SPField.)
	JSLink	Gets or sets the name of an external JavaScript file that contains any client rendering logic for fields of this type. (Inherited from SPFieldMultiChoice.)
	JumpToField	Gets the name of a field that represents the next question to which users are taken in a survey, which is dependent on the answer they give to the current question. (Inherited from SPField.)
	LinkToItem	Gets or sets an indication of whether the field should show a link to the list item's display form when displayed in a list view. (Inherited from SPField.)
	LinkToItemAllowed	Gets or sets an indication of whether the field, in List View, can show a link to the list item's display form. (Inherited from SPField.)
	ListItemMenu	Gets or sets an indication of whether the field should show a link to the list item's drop down menu when displayed in a list view. (Inherited from SPField.)
	ListItemMenuAllowed	Gets or sets an indication of whether the field, in List View, can show a link to the list item's drop down menu. (Inherited from SPField.)
	Mappings	Gets the canonical values for the specified choices. (Inherited from SPFieldMultiChoice.)
	NoCrawl	Gets or sets a Boolean value that specifies whether the field can be crawled by a search engine. (Inherited from SPField.)
	NodeChoices	Gets or sets the XML that defines the choices. (Inherited from SPFieldMultiChoice.)
	ParentList	Gets the parent list that contains the field. (Inherited from SPField.)
	PIAttribute	Gets or sets the attribute in the document processing instruction (specified by the PITarget property) that is used as the column value for property promotion and demotion in XML documents. (Inherited from SPField.)
	PITarget	Gets or sets the document processing instruction in which the column value is stored in documents of the specified content type, which is used for property promotion and demotion in XML documents. (Inherited from SPField.)
	PreviewValueTyped	Gets a preview value of field data for a design-time view of the field control in Display and Edit modes, when there is no list item data that is associated with the field. (Overrides SPFieldMultiChoice.PreviewValueTyped.)
	PrimaryPIAttribute	Gets or sets an alternate attribute in the document processing instruction, specified by the PrimaryPITarget property, that is used as the column value in property promotion and demotion in XML documents. (Inherited from SPField.)
	PrimaryPITarget	Gets or sets an alternative document processing instruction in which the column value is stored for documents of the specified content type. (Inherited from SPField.)
	PushChangesToLists	Gets or sets a Boolean value that specifies whether to propagate changes that are made in the field template to lists that implement the field. (Inherited from SPField.)
	RangeCount	Gets the number of options for each subordinate question from which users can choose in the rating scale field.
	ReadOnlyField	Gets or sets a Boolean value that specifies whether values in the field can be modified. (Inherited from SPField.)
	RelatedField	Gets or sets the internal name of a field to which the current field is related. (Inherited from SPField.)
	Reorderable	Gets a Boolean value that indicates whether values in the field can be reordered. (Inherited from SPField.)
	Required	Gets or sets a Boolean value that determines whether users must enter a value for the field on New and Edit forms. (Inherited from SPField.)
	SchemaXml	Gets or sets the schema that defines the field. (Inherited from SPField.)
	SchemaXmlWithResourceTokens	Gets the schema that defines the field and includes resource tokens. (Inherited from SPField.)
	Scope	Gets the Web site-relative path to the list in which the field collection is used. (Inherited from SPField.)
	Sealed	Gets a value that indicates whether Microsoft SharePoint Foundation field type (as specified in the Type property) can be the parent of a custom derived field type. (Inherited from SPField.)
	ShowInDisplayForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form for displaying list items. (Inherited from SPField.)
	ShowInEditForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to edit list items. (Inherited from SPField.)
	ShowInListSettings	Gets or sets a Boolean value that specifies whether the field is displayed in the page for customizing list settings. (Inherited from SPField.)
	ShowInNewForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to create list items. (Inherited from SPField.)
	ShowInVersionHistory	Gets or sets a Boolean value that specifies whether the field is displayed in the page for viewing list item versions. (Inherited from SPField.)
	ShowInViewForms	Gets or sets a Boolean value that specifies whether the field is displayed in pages that are used to view list data. (Inherited from SPField.)
	Sortable	Gets a Boolean value that indicates whether the rating-scale field can be sorted. (Overrides SPFieldMultiChoice.Sortable.)
	SourceId	Gets either the namespace that defines a built-in field or, if it a custom field, the GUID that identifies the list or Web site where it was created. (Inherited from SPField.)
	StaticName	Gets or sets a static name for the field. (Inherited from SPField.)
	Title	Gets or sets the display name for the field. (Inherited from SPField.)
	TitleResource	Gets the resource object associated with the field’s display name. (Inherited from SPField.)
	TranslationXml	Document content that has been stored in a multilingual database for display as an XML document. (Inherited from SPField.)
	Type	Gets or sets the type of the field. (Inherited from SPField.)
	TypeAsString	Gets the type of the field as a string value. (Inherited from SPField.)
	TypeDisplayName	Gets the display name of the field type. (Inherited from SPField.)
	TypeShortDescription	Gets the description of the field. (Inherited from SPField.)
	UsedInWebContentTypes	Gets a Boolean value that indicates whether the field is implemented in any content type that is used in the site collection. (Inherited from SPField.)
	ValidationEcmaScript	Gets an ECMAScript function that corresponds to the field’s validation formula. (Inherited from SPField.)
	ValidationFormula	Indicates the formula referenced by the field and is evaluated when a list item is added or updated. (Inherited from SPField.)
	ValidationMessage	Gets or sets a message to display to the user if validation fails for this field. (Inherited from SPField.)
	Version	Gets the version of the field. (Inherited from SPField.)
	XPath	Gets or sets the XPath expression to the field. (Inherited from SPField.)

Top

Methods

	Name	Description
	AddChoice	Adds a choice to the Choices collection. (Inherited from SPFieldMultiChoice.)
	AnnotateField	When overridden in a derived class, adds attributes to the specified XML node and assigns them values from the properties of this SPField object. (Inherited from SPField.)
	Delete	Deletes the field. (Inherited from SPField.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetCustomProperty	Gets the value of custom property with the specified name. (Inherited from SPField.)
	GetFieldValue	Converts the specified value into a field type value object when a field type requires a complex data type that is different from the parent field type. (Overrides SPFieldMultiChoice.GetFieldValue(String).)
	GetFieldValueAsHtml	Gets the field value in HTML format in order to render the field value directly on the page. (Inherited from SPFieldMultiChoice.)
	GetFieldValueAsText	Returns the field value as plain text. (Overrides SPFieldMultiChoice.GetFieldValueAsText(Object).)
	GetFieldValueForClientRender	Converts the field type value into object for use in client Display, Edit and New item forms. (Inherited from SPFieldMultiChoice.)
	GetFieldValueForEdit	Gets the field value that is rendered in Edit mode in Edit and New forms. (Inherited from SPField.)
	GetHashCode	(Inherited from Object.)
	GetJsonClientFormFieldSchema	Gets an object containing information from the field's schema that is useful for client rendering of the field in forms. (Inherited from SPFieldMultiChoice.)
	GetProperty	Gets the value of the specified property. (Inherited from SPField.)
	GetType	(Inherited from Object.)
	GetValidatedString	Validates and converts the field value into a serialized form. (Inherited from SPField.)
	HasValue	Internal function used to verify whether an object is null or not. (Inherited from SPField.)
	InitChoiceCollection	Used in derived classes to change the way that elements and attributes are read from the XML that defines choices. (Inherited from SPFieldMultiChoice.)
	InitFieldNodes	Initializes the nodes within the field. (Inherited from SPFieldMultiChoice.)
	ListsFieldUsedIn	Returns information about the Web sites and lists in which the current field is used. (Inherited from SPField.)
	MemberwiseClone	(Inherited from Object.)
	OnAdded	Handles the event that occurs after a field is added. (Inherited from SPField.)
	OnAddingToContentType	Handles the event that occurs when a field is added to a specified content type. (Inherited from SPField.)
	OnDeleting	Handles the event that occurs when a field is being deleted. (Inherited from SPField.)
	OnDeletingFromContentType	Handles the event that occurs when a field is deleted from a specified content type. (Inherited from SPField.)
	OnInitFieldNode	This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from SPField.)
	OnUpdated	Handles the event that occurs after changes are made to a field. (Inherited from SPField.)
	ParseAndSetValue	When overridden in a derived class, sets the specified field item to the specified value. (Inherited from SPField.)
	ParseValue	When overridden in a derived class, parses a potential value of the field and returns an object that can be assigned as the value of the field. (Inherited from SPField.)
	RemoveChoice	Removes a choice from the Choices collection. (Inherited from SPFieldMultiChoice.)
	RenderFieldValueAsJson	Returns the specified value in JSON format. (Inherited from SPFieldMultiChoice.)
	RevertCustomizations	Reverts customizations made to the field schema. (Inherited from SPField.)
	SetCustomProperty	Sets a value for the specified property. (Inherited from SPField.)
	ToString	Returns the title of the field. (Inherited from SPField.)
	Update()	Updates the database with changes made to the field. (Inherited from SPFieldMultiChoice.)
	Update(Boolean)	Updates the database with changes that are made to the field and optionally propagates the changes to lists that implement the field. (Inherited from SPField.)
	UpdateInternal	Updates the database with changes that are made to the field. In a derived class, override this method if you change the value of the NodeChoices property. (Inherited from SPFieldMultiChoice.)
	ValidateAndParseValue	Validates and parses the input value and returns a valid object that can be the value of the field. (Inherited from SPFieldMultiChoice.)
	ValidateParseAndSetValue	Calls ValidateAndParseValue(SPListItem, String) and assigns the returned object as the value of the field. (Inherited from SPField.)

Top

See also

Reference

SPFieldRatingScale class

Microsoft.SharePoint namespace