IReportViewerMessages Interface

Article
09/02/2015

Allows applications to provide customized user interface messages.

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

Syntax

public interface IReportViewerMessages

public interface class IReportViewerMessages

type IReportViewerMessages = interface end

Public Interface IReportViewerMessages

Properties

	Name	Description
	BackButtonToolTip	Provides the ToolTip text for the Back button.
	BackMenuItemText	Provides the text for the Back menu item.
	ChangeCredentialsText	Provides the text for the Change Credentials button.
	CurrentPageTextBoxToolTip	Provides the ToolTip text for the Current Page text box.
	DocumentMapButtonToolTip	Provides the ToolTip text for the Document Map button.
	DocumentMapMenuItemText	Provides the text for the document map menu item.
	ExportButtonToolTip	Provides the ToolTip text for the Export button.
	ExportMenuItemText	Provides the text for the Export menu item.
	FalseValueText	Provides the text for a false value.
	FindButtonText	Provides the text for a Find button.
	FindButtonToolTip	Provides the ToolTip text for the Find button.
	FindNextButtonText	Provides the text for the Find Next button.
	FindNextButtonToolTip	Provides the ToolTip text for the Find Next button.
	FirstPageButtonToolTip	Provides the ToolTip text for the First Page button.
	LastPageButtonToolTip	Provides the ToolTip text for the Last Page button.
	NextPageButtonToolTip	Provides the ToolTip text for the Next Page button.
	NoMoreMatches	Provides the text for the no more matches message.
	NullCheckBoxText	Provides the text for the Null check box.
	NullCheckBoxToolTip	Provides the ToolTip text for the Null check box.
	NullValueText	Provides the text for a null value.
	PageOf	Provides the text for the pagination message.
	PageSetupButtonToolTip	Provides the ToolTip text for the Page Setup button.
	PageSetupMenuItemText	Provides the text for the Page Setup menu item.
	ParameterAreaButtonToolTip	Provides the ToolTip text for the Parameter Area button.
	PasswordPrompt	Provides the text for the password prompt.
	PreviousPageButtonToolTip	Provides the ToolTip text for the Previous Page button.
	PrintButtonToolTip	Provides the text for the Print button.
	PrintLayoutButtonToolTip	Provides the ToolTip text for the Print Layout button.
	PrintLayoutMenuItemText	Provides the text for the Print Layout menu item.
	PrintMenuItemText	Provides the text for the Print menu item.
	ProgressText	Provides the text for the progress message that is displayed when a report is processing.
	RefreshButtonToolTip	Provides the ToolTip text for the Refresh button.
	RefreshMenuItemText	Provides the text for the Refresh menu item.
	SearchTextBoxToolTip	Provides the ToolTip text for the Search text box.
	SelectAll	Provides text for the Select All item in a multivalue drop-down list box.
	SelectAValue	Provides text for the Select a value prompt.
	StopButtonToolTip	Provides the ToolTip text for the Stop button.
	StopMenuItemText	Provides the text for the Stop menu item.
	TextNotFound	Provides the text for the text not found message.
	TotalPagesToolTip	Provides the ToolTip text for the Total Pages item.
	TrueValueText	Provides the text for a true value.
	UserNamePrompt	Provides the text for the user name prompt.
	ViewReportButtonText	Provides the text for the View Report button.
	ViewReportButtonToolTip	Provides the ToolTip text for the View Report button.
	ZoomControlToolTip	Provides the ToolTip text for the Zoom control.
	ZoomMenuItemText	Provides the text for the Zoom menu item.
	ZoomToPageWidth	Provides the text for the Zoom To Page Width option.
	ZoomToWholePage	Provides text for the Zoom To Whole Page item.

Remarks

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.

Note

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.

Examples

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
    }
}