Microsoft.SharePoint.Utilities namespace

  • Article

Used for various utilities tasks, including encoding of strings and processing of user information.

Classes

  Class Description
Public class AttachmentEnumerator Represents an enumerator for SPEmailMessage attachments.
Public class ByteArrayComparer Helper class to compare byte arrays.
Public class DateOptions Provides access to properties and methods that are used to view and set date options.
Public class DesignPreviewSaveData
Public class HostBlobDataCounter
Public class IntlDate Represents an international date value.
Public class MoblogUtility Specifies enumerations for a mobile Web log site.
Public class PageUrlNormalization Normalizes URLs to ensure equivalence between different forms of the same URL.
Public class RightsSensitiveVisibilityHelper Represents a hyperlink that is hidden if the current user does not have appropriate permissions for the current Web site or list.
Public class SPADOperationsScope Scope containing AD opetaion properties.
Public class SPAsyncThreadDiagnosticsContext This is an utility class used in async thread for diagnostics info. It is suposed to called in the async thread. to set the right correlation and ULS trace override context.
Public class SPBucketHealthScoreCalculator Provides computation of health scores for a specific performance value based on the range of possible values ("bucket") into which the value falls.
Public class SPCallCounter This counter monitors the number of calls to an arbitrary API (WCF service calls) made during a request.
Public class SPClaimsCounter
Public class SPClaimsCounterScope
Public class SPColor Represents a color scheme as described in an SPColor XML file. Describes color slots
Public class SPCPUCycleCounter This monitor is used to track the CPU cycles.
Public class SPCPUCycleData A helper class to count the cycles. It starts record ticks in contructor and stop ticks in Dispose(). In Dispose(), it will add the cycles to the SPCPUCycleCounter of SPMonitoredScopes
Public class SPCriticalTraceCounter This monitor tracks critical windows events and asserts that occur during an operation, such as a page browse. Tracking includes the event text, id, call stack.
Public class SPCurrentUsernameMonitor
Public class SPCustomRedirect Class that manages custom redirect handler registration, and returning the redirect URL based on registered handlers This allows a fallback mechanism for cases in which redirection using the "Source" parameter is not adequate. An example would be enabling redirection between two web applications with different host names, in which "Source" validation would fail
Public class SPDiagnosticDataProvider An abstract definition of the information provider for the diagnostic.
Public class SPDiagnosticsState Provides the state information needed to allow asynchronous operations to provide diagnostic information that can be coordinated with the original request
Public class SPDiffUtility Provides a method and supporting properties to determine the text differences between two strings.
Public class SPEmailAttachment Represents an attachment in an e-mail message.
Public class SPEmailAttachmentCollection Represents the attachments in an e-mail message.
Public class SPEmailHeader Represents a message header for an e-mail message.
Public class SPEmailHeaderCollection Represents the collection of message headers for an e-mail message.
Public class SPEmailMessage Represents a MIME-formatted e-mail message.
Public class SPEncode Provides methods for encoding strings.
Public class SPExecutionTimeCounter Represents a monitor that tracks execution time for an operation.
Public class SPFileExtensionsCollection A collection for storing file extensions (aspx, ascx etc.).
Public class SPFont Represents a font scheme as described in an SPFont XML file. Describes font family slots and font size slots
Public class SPHealthScoreCalculator When implemented in a derived class, provides a method for translating a performance value into a health score from 0 to 10.
Public class SPHttpFileExtensionThrottleClassifier Enables the management of throttling of HTTP requests for a resource with specified extension.
Public class SPHttpHeaderThrottleClassifier Enables the management of throttling for HTTP requests that include a specified header.
Public class SPHttpThrottleSettings Provides management and configuration settings for performance monitoring and HTTP request throttling.
Public class SPHttpThrottlingMonitors Represents a collection of objects which can be used to create performance monitors for a Web application.
Public class SPHttpUserAgentAndMethodClassifier Enables the management of throttling for HTTP requests for a specified user agent, a specified HTTP method, or a combination of agent and method.
Public class SPHttpUtility Provides access to methods used to encode and decode strings during the processing of Web requests.
Public class SPIntlCal Represents an international calendar.
Public class SPKeyValuePairSerializationInfo Stores data that is needed to serialize and deserialize an object.
Public class SPMobileUtility Provides access to methods and enumerations for working with a mobile Web application.
Public class SPMonitoredScope Monitors performance and resource use for a specified scoped block of code.
Public class SPPerformanceMonitorCreationData Provides information needed to create a performance monitor.
Public class SPPrincipalInfo Provides access to information about the current principal.
Public class SPPropertyBag Stores arbitrary key and value pairs that contain custom property settings.
Public class SPRelativeDateTime
Public class SPRequestThrottleClassifier When implemented in a derived class, provides a means of assigning a throttle level to a type of HTTP request.
Public class SPRequestUsageCounter Tracks the number of opened SPRequest objects.
Public class SPRerunDiscoveryJobDefinition
Public class SPResourceBudget Monitors the usage of specified resources within a code block.
Public class SPSafeThread Provides a thread safe class wrapper.
Public class SPSearchCrawlingRequestClassifier Enables the management of throttling for HTTP requests that come from search crawlers.
Public class SPSqlExceptionsMonitor
Public class SPSqlIoMonitor
Public class SPSqlLatencyMonitor
Public class SPSqlQueryCounter Represents a monitor that tracks information about the SQL queries that are made during an operation. For each query, this monitor tracks the SqlQueryData text, the call stack, and the duration.
Public class SPStringUtility Provides access to methods for manipulating strings.
Public class SPSystemPerformanceCounterMonitor Represents a monitor for the value of a specific system performance counter.
Public class SPSystemPerformanceMonitor Represents a monitor that tracks some aspect of the performance of the SharePoint Foundation deployment.
Public class SPSystemPerformanceMonitorCollection Represents a collection of performance monitoring objects.
Public class SPTheme Represents a theme as described in an SPTheme XML file.
Public class SPThreadPool Provides access to methods for queuing a method for execution by using the identity of a remote user or a specified user token.
Public class SPUrlUtility Provides access to methods that operate on URLs.
Public class SPUtility Provides tools for converting date and time formats, for obtaining information from user names, for modifying access to sites, and for various other tasks in managing deployments of Microsoft SharePoint Foundation.
Public class SPWebRequest Helper calss that creates outbound web requests. The produced web requests may have restrictions or enhancements specific to SharePoint.
Public class SqlQueryData Represents a container for SQL query information that is used for diagnostic purposes.
Public class ThemeBorderValues size constants for theme border
Public class ThemeColor Represents a color in a set of base colors within the context of a ThmxTheme object. A theme color consists of a default color and an associated list of shades.
Public class ThemeFont Represents a theme font within the context of a ThmxTheme object. A theme font consists of at least three script fonts accompanied by a dictionary of optional script-font mappings.
Public class ThemeFontFace
Public class ThemeSizeValues size constants for theme radius
Public class ThmxTheme Represents a Microsoft Office XML theme file. The methods and properties of this class enable read and write operations on the theme name, the color list, and the font list.

Structures

  Structure Description
Public structure SimpleDate Represents a date value containing the year, month, and day in any local calendar.

Interfaces

  Interface Description
Public interface ISPCalendar Provides methods for working with the local calendar.
Public interface ISPCustomRedirectHandler Interface for a class that gives a custom redirect URL, based on a key parameter. This is used as a fallback mechanism for cases when the "Source" parameter is not adequate
Public interface ISPPerformanceMonitor Implement this interface to count and describe the number of queries that are sent to an external database.
Public interface ISPScopedPerformanceMonitor Implement this interface to create a monitor to measure performance metrics within a given scope in code.
Public interface ISPTheme
Public interface ISqlSession Provides an interface to access databases by using the .NET Data Provider for SQL Server.
Public interface ISupportNameValuePairsSerialization

Delegates

  Delegate Description
Public delegate SPSafeThread.CodeToRun Delegate for SPSafeThread used to run background threads to handle any exception that might be thrown. An exception caught is logged and the thread is discontinued without affecting the calling process.

Enumerations

  Enumeration Description
Public enumeration AuthenticationRestrictions Specifies whether access is restricted to only authenticated users, only anonymous users, or is available to all users.
Public enumeration DBCSQueryStringEncodings Specifies whether double-byte character set (DBCS) query strings use Unicode or UTF8 encoding.
Public enumeration FormatConversionOption Specifies the format to use for Web Part conversions.
Public enumeration IconSize Specifies the default icon size.
Public enumeration ItemUrlType Enumerates SharePoint URL types.
Public enumeration LogAppErrorResult Enumeration for the result of LogCustomAppError and LogCustomRemoteAppError
Public enumeration PageModes Specifies the page mode required to view items.
Public enumeration PageUrlNormalizationOption Enumerator for Modifier Options
Public enumeration PermissionContext Specifies the context object to which a permission mask is applied.
Public enumeration PermissionMode Specifies whether the user must have all of the rights specified in the permission mask to view a link, or only one of the rights specified in the permission mask.
Public enumeration PresenceIndicatorSize Available sizes for the IM Presence Indicator jewel/bar.
Public enumeration SPBehaviorInternal For methods whose behavior has changed between Windows SharePoint Services 2.0 and Windows SharePoint Services 3.0, this class specifies which behavior to use.
Public enumeration SPClaimsAuthenticationTimeCategory
Public enumeration SPDateFormat Specifies the date and time format.
Public enumeration SPHttpUserAgentAndMethodClassifier.MatchSettings Specifies how an HTTP request must match the property values of a user agent and HTTP method request classifier in order for the classier to manage the throttling of the request.
Public enumeration SPLangId Provides access to the integer identifier of the local language.
Public enumeration SPPrincipalSource Specifies the source of the current principal.
Public enumeration SPPrincipalType Specifies the principal type.
Public enumeration SPRedirectFlags Specifies flags for a redirect operation.
Public enumeration SPRequestThrottleLevel Specifies when HTTP requests are throttled.
Public enumeration SPSessionCredentialsFlags Specifies whether the SharePoint session requires authentication.
Public enumeration SPSystemPerformanceCounterRelativeInstance Indicates whether an instance of a counter is given the name of the Web application (e.g., “SharePoint – 80”) or the name of the process in which it is running (e.g., “w3wp”).
Public enumeration SPTypeOfRedirect Enumerator that specifies the type of redirect URL requested.
Public enumeration SPWebServiceBehavior Specifies web service behavior.
Public enumeration SPWOPIAction
Public enumeration SPWOPIFrameAction Indicates which WOPI Action should be started for the associated SPListItem.
Public enumeration ThemeType Represents the state of a ThmxTheme object and its relationship with SharePoint theme features.