IReportViewerMessages Interface

 

Allows applications to provide customized user interface messages.

Namespace:   Microsoft.Reporting.WebForms
Assembly:  Microsoft.ReportViewer.WebForms (in Microsoft.ReportViewer.WebForms.dll)

public interface IReportViewerMessages

NameDescription
System_CAPS_pubpropertyBackButtonToolTip

Provides the ToolTip text for the Back button.

System_CAPS_pubpropertyChangeCredentialsText

Provides the text for the Change Credentials button.

System_CAPS_pubpropertyChangeCredentialsToolTip

Provides the ToolTip text for the Change Credentials button.

System_CAPS_pubpropertyCurrentPageTextBoxToolTip

Provides the ToolTip text for the Current Page text box.

System_CAPS_pubpropertyDocumentMap

Provides the title text for the Document Map panel.

System_CAPS_pubpropertyDocumentMapButtonToolTip

Provides the ToolTip text for the Document Map button.

System_CAPS_pubpropertyExportButtonText

Provides the text for the Export button.

System_CAPS_pubpropertyExportButtonToolTip

Provides the ToolTip text for the Export button.

System_CAPS_pubpropertyExportFormatsToolTip

Provides the ToolTip text for the Export Formats drop-down list box.

System_CAPS_pubpropertyFalseValueText

Provides the text for a false value.

System_CAPS_pubpropertyFindButtonText

Provides the text for a Find button.

System_CAPS_pubpropertyFindButtonToolTip

Provides the ToolTip text for the Find button.

System_CAPS_pubpropertyFindNextButtonText

Provides the text for the Find Next button.

System_CAPS_pubpropertyFindNextButtonToolTip

Provides the ToolTip text for the Find Next button.

System_CAPS_pubpropertyFirstPageButtonToolTip

Provides the ToolTip text for the First Page button.

System_CAPS_pubpropertyInvalidPageNumber

Provides the text for the invalid page number message.

System_CAPS_pubpropertyLastPageButtonToolTip

Provides the ToolTip text for the Last Page button.

System_CAPS_pubpropertyNextPageButtonToolTip

Provides the ToolTip text for the Next Page button.

System_CAPS_pubpropertyNoMoreMatches

Provides the text for the no more matches message.

System_CAPS_pubpropertyNullCheckBoxText

Provides the text for the Null check box.

System_CAPS_pubpropertyNullValueText

Provides the text for a null value.

System_CAPS_pubpropertyPageOf

Provides the text for the pagination message.

System_CAPS_pubpropertyParameterAreaButtonToolTip

Provides the ToolTip text for the Parameter Area button.

System_CAPS_pubpropertyPasswordPrompt

Provides the text for the password prompt.

System_CAPS_pubpropertyPreviousPageButtonToolTip

Provides the ToolTip text for the Previous Page button.

System_CAPS_pubpropertyPrintButtonToolTip

Provides the text for the Print button.

System_CAPS_pubpropertyProgressText

Provides the text for the progress message that is displayed when a report is processing.

System_CAPS_pubpropertyRefreshButtonToolTip

Provides the ToolTip text for the Refresh button.

System_CAPS_pubpropertySearchTextBoxToolTip

Provides the ToolTip text for the Search text box.

System_CAPS_pubpropertySelectAll

Provides the text for the Select All item in a multivalue drop-down list box.

System_CAPS_pubpropertySelectAValue

Provides the text for the Select a value prompt.

System_CAPS_pubpropertySelectFormat

Provides the text for the select format prompt.

System_CAPS_pubpropertyTextNotFound

Provides the text for the 'text not found' message.

System_CAPS_pubpropertyTodayIs

Provides the text for the 'Today is…' message in the calendar control.

System_CAPS_pubpropertyTrueValueText

Provides the text for a true value.

System_CAPS_pubpropertyUserNamePrompt

Provides the text for the user name prompt.

System_CAPS_pubpropertyViewReportButtonText

Provides the text for the View Report button.

System_CAPS_pubpropertyZoomControlToolTip

Provides the ToolTip for the Zoom control.

System_CAPS_pubpropertyZoomToPageWidth

Provides the text for the Zoom To Page Width option.

System_CAPS_pubpropertyZoomToWholePage

Provides text for the Zoom To Whole Page item.

You can implement the IReportViewerMessages interface to provide custom localization of the ReportViewer control user interface. This implementation can be passed to the ReportViewer control by adding a custom application setting to the the web.config configuration file using the key “ReportViewerMessages”.

For example:

<appSettings>

<add key="ReportViewerMessages" value="MyClass, MyAssembly" />

</appSettings>

Note   Please see Web.config Settings for ReportViewer for more information on web configuration settings.

Returning a null string value for a property will cause the ReportViewer control to display the original user interface string for that item.

Legacy Code Example

The following code is an example of a class that implements the IReportViewerMessages interface.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Reporting.WebForms;

namespace MySample
{
    public class CReportViewerCustomMessages :
        Microsoft.Reporting.WebForms.IReportViewerMessages
    {
        #region IReportViewerMessages Members

        public string BackButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string ChangeCredentialsText
        {
            get { return("Add your custom text here."); }
        }

        public string ChangeCredentialsToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string CurrentPageTextBoxToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string DocumentMap
        {
            get { return("Add your custom text here."); }
        }

        public string DocumentMapButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string ExportButtonText
        {
            get { return("Add your custom text here."); }
        }

        public string ExportButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string ExportFormatsToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string FalseValueText
        {
            get { return("Add your custom text here."); }
        }

        public string FindButtonText
        {
            get { return("Add your custom text here."); }
        }

        public string FindButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string FindNextButtonText
        {
            get { return("Add your custom text here."); }
        }

        public string FindNextButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string FirstPageButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string InvalidPageNumber
        {
            get { return("Add your custom text here."); }
        }

        public string LastPageButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string NextPageButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string NoMoreMatches
        {
            get { return("Add your custom text here."); }
        }

        public string NullCheckBoxText
        {
            get { return("Add your custom text here."); }
        }

        public string NullValueText
        {
            get { return("Add your custom text here."); }
        }

        public string PageOf
        {
            get { return("Add your custom text here."); }
        }

        public string ParameterAreaButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string PasswordPrompt
        {
            get { return("Add your custom text here."); }
        }

        public string PreviousPageButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string PrintButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string ProgressText
        {
            get { return("Add your custom text here."); }
        }

        public string RefreshButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string SearchTextBoxToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string SelectAValue
        {
            get { return("Add your custom text here."); }
        }

        public string SelectAll
        {
            get { return("Add your custom text here."); }
        }

        public string SelectFormat
        {
            get { return("Add your custom text here."); }
        }

        public string TextNotFound
        {
            get { return("Add your custom text here."); }
        }

        public string TodayIs
        {
            get { return("Add your custom text here."); }
        }

        public string TrueValueText
        {
            get { return("Add your custom text here."); }
        }

        public string UserNamePrompt
        {
            get { return("Add your custom text here."); }
        }

        public string ViewReportButtonText
        {
            get { return("Add your custom text here."); }
        }

        public string ZoomControlToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string ZoomToPageWidth
        {
            get { return("Add your custom text here."); }
        }

        public string ZoomToWholePage
        {
            get { return("Add your custom text here."); }
        }

        #endregion
    }
}
Return to top
Show: