IReportViewerMessages Interface

 

Allows applications to provide customized user interface messages.

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

public interface IReportViewerMessages

NameDescription
System_CAPS_pubpropertyBackButtonToolTip

Provides the ToolTip text for the Back button.

System_CAPS_pubpropertyBackMenuItemText

Provides the text for the Back menu item.

System_CAPS_pubpropertyChangeCredentialsText

Provides the text for the Change Credentials button.

System_CAPS_pubpropertyCurrentPageTextBoxToolTip

Provides the ToolTip text for the Current Page text box.

System_CAPS_pubpropertyDocumentMapButtonToolTip

Provides the ToolTip text for the Document Map button.

System_CAPS_pubpropertyDocumentMapMenuItemText

Provides the text for the document map menu item.

System_CAPS_pubpropertyExportButtonToolTip

Provides the ToolTip text for the Export button.

System_CAPS_pubpropertyExportMenuItemText

Provides the text for the Export menu item.

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_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_pubpropertyNullCheckBoxToolTip

Provides the ToolTip 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_pubpropertyPageSetupButtonToolTip

Provides the ToolTip text for the Page Setup button.

System_CAPS_pubpropertyPageSetupMenuItemText

Provides the text for the Page Setup menu item.

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_pubpropertyPrintLayoutButtonToolTip

Provides the ToolTip text for the Print Layout button.

System_CAPS_pubpropertyPrintLayoutMenuItemText

Provides the text for the Print Layout menu item.

System_CAPS_pubpropertyPrintMenuItemText

Provides the text for the Print menu item.

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_pubpropertyRefreshMenuItemText

Provides the text for the Refresh menu item.

System_CAPS_pubpropertySearchTextBoxToolTip

Provides the ToolTip text for the Search text box.

System_CAPS_pubpropertySelectAll

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

System_CAPS_pubpropertySelectAValue

Provides text for the Select a value prompt.

System_CAPS_pubpropertyStopButtonToolTip

Provides the ToolTip text for the Stop button.

System_CAPS_pubpropertyStopMenuItemText

Provides the text for the Stop menu item.

System_CAPS_pubpropertyTextNotFound

Provides the text for the text not found message.

System_CAPS_pubpropertyTotalPagesToolTip

Provides the ToolTip text for the Total Pages item.

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_pubpropertyViewReportButtonToolTip

Provides the ToolTip text for the View Report button.

System_CAPS_pubpropertyZoomControlToolTip

Provides the ToolTip text for the Zoom control.

System_CAPS_pubpropertyZoomMenuItemText

Provides the text for the Zoom menu item.

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 setting the Messages property of the ReportViewer control.

System_CAPS_noteNote

The IReportViewerMessages interface does not allow customization of local or server report processing error messages.

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 sample shows an implementation of IReportViewerMessages being passed to the ReportViewer control.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Reporting.WinForms;
using System.Diagnostics;

namespace MySample
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            CCustomMessageClass myMessageClass = new CCustomMessageClass();

            reportViewer1.Messages = myMessageClass;

            this.reportViewer1.RefreshReport();

         }
    }

    public class CCustomMessageClass : IReportViewerMessages
    {

        #region IReportViewerMessages Members

        public string BackButtonToolTip
        {
            get { return ("BackButtonToolTip here."); }
        }

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

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

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

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

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

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

        public string ExportMenuItemText
        {
            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("Custom first page tool tip"); }
        }

        public string LastPageButtonToolTip
        {
            get { return(null); }
        }

        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 NullCheckBoxToolTip
        {
            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 PageSetupButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

        public string PageSetupMenuItemText
        {
            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 PrintLayoutButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

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

        public string PrintMenuItemText
        {
            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 RefreshMenuItemText
        {
            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 StopButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

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

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

        public string TotalPagesToolTip
        {
            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 ViewReportButtonToolTip
        {
            get { return("Add your custom text here."); }
        }

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

        public string ZoomMenuItemText
        {
            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: