MapPrintOptions Class

Contains map print options.

Namespace: DevExpress.Xpf.Map

Assembly: DevExpress.Xpf.Map.v19.1.dll

Declaration

C#

public class MapPrintOptions :
    MapDependencyObject

VB.NET

Public Class MapPrintOptions
    Inherits MapDependencyObject

Related API Members

The following members return MapPrintOptions objects:

• MapControl.PrintOptions

Remarks

Export also depends on these settings. To see examples, refer to the Map Control. Printing and Exporting section.

Example

To print a map, use one of the following methods.

• MapControl.ShowRibbonPrintPreview - invokes the Print Preview Form with the Ribbon bar;
• MapControl.ShowRibbonPrintPreviewDialog - invokes the modal Print Preview Form with the Ribbon bar;
• MapControl.ShowPrintPreview - invokes the Print Preview Form;
• MapControl.ShowPrintPreviewDialog - invokes the modal Print Preview Form;

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-print-a-map-t200441.

MainWindow.xaml

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:sys="clr-namespace:System;assembly=mscorlib"
        xmlns:dxp="http://schemas.devexpress.com/winfx/2008/xaml/printing"
        xmlns:dxlc="http://schemas.devexpress.com/winfx/2008/xaml/layoutcontrol"
        xmlns:dxm="http://schemas.devexpress.com/winfx/2008/xaml/map"  
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors" 
        xmlns:local="clr-namespace:PrintingExporting"
        x:Class="PrintingExporting.MainWindow"
        Title="MainWindow" Height="600" Width="800">

    <Window.Resources>
        <ObjectDataProvider x:Key="PrintSizeValues" MethodName="GetValues"
                            ObjectType="{x:Type sys:Enum}">
            <ObjectDataProvider.MethodParameters>
                <x:Type TypeName="dxm:MapPrintSizeMode" />
            </ObjectDataProvider.MethodParameters>
        </ObjectDataProvider>
        <ObjectDataProvider x:Key="PrintMethodValues" MethodName="GetValues"
                            ObjectType="{x:Type sys:Enum}">
            <ObjectDataProvider.MethodParameters>
                <x:Type TypeName="local:PrintMetod"/>
            </ObjectDataProvider.MethodParameters>
        </ObjectDataProvider>
    </Window.Resources>

    <Grid>
        <dxlc:LayoutControl>
            <dxlc:LayoutGroup Orientation="Vertical">
                <dxlc:LayoutItem HorizontalAlignment="Stretch" VerticalAlignment="Stretch">
                    <dxm:MapControl Name="mapControl">
                        <dxm:MapControl.PrintOptions>
                            <dxm:MapPrintOptions SizeMode="{Binding SelectedItem, ElementName=cbPrintingSize}"/>
                        </dxm:MapControl.PrintOptions>
                        <dxm:ImageTilesLayer>
                            <dxm:ImageTilesLayer.DataProvider>
                                <dxm:BingMapDataProvider BingKey="Your Bing Key"/>
                            </dxm:ImageTilesLayer.DataProvider>
                        </dxm:ImageTilesLayer>
                    </dxm:MapControl>
                </dxlc:LayoutItem>
                <dxlc:LayoutGroup>
                    <dxlc:LayoutItem Label="Printing Size" AddColonToLabel="True">
                        <ComboBox x:Name="cbPrintingSize" SelectedIndex="0"
                                  ItemsSource="{Binding Source={StaticResource PrintSizeValues}}"/>
                    </dxlc:LayoutItem>
                    <dxlc:LayoutItem Label="Print Method" AddColonToLabel="True">
                        <ComboBox x:Name="cbPrintingMethod" SelectedIndex="0"
                                  ItemsSource="{Binding Source={StaticResource PrintMethodValues}}"/>
                    </dxlc:LayoutItem>
                    <dxlc:LayoutItem Width="100">
                        <Button Content="Print" Click="Button_Click"/>
                    </dxlc:LayoutItem>
                </dxlc:LayoutGroup>
            </dxlc:LayoutGroup>
        </dxlc:LayoutControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Windows;

namespace PrintingExporting {
    public enum PrintMetod { RibbonPreview, RibbonPreviewDialog, Preview, PreviewDialog };

    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
        }

        private void Button_Click(object sender, RoutedEventArgs e) {
            #region #PrintMethods
            switch ((PrintMetod)cbPrintingMethod.SelectedItem) {
                case (PrintMetod.RibbonPreview):
                    mapControl.ShowRibbonPrintPreview(this);
                    break;
                case (PrintMetod.RibbonPreviewDialog):
                    mapControl.ShowRibbonPrintPreviewDialog(this);
                    break;
                case (PrintMetod.Preview):
                    mapControl.ShowPrintPreview(this);
                    break;
                case (PrintMetod.PreviewDialog):
                    mapControl.ShowPrintPreviewDialog(this);
                    break;
            }
            #endregion #PrintMethods
        }
    }
}

MainWindow.xaml.vb

Imports System.Windows

Namespace PrintingExporting
    Public Enum PrintMetod
        RibbonPreview
        RibbonPreviewDialog
        Preview
        PreviewDialog
    End Enum

    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
'            #Region "#PrintMethods"
            Select Case CType(cbPrintingMethod.SelectedItem, PrintMetod)
                Case (PrintMetod.RibbonPreview)
                    mapControl.ShowRibbonPrintPreview(Me)
                Case (PrintMetod.RibbonPreviewDialog)
                    mapControl.ShowRibbonPrintPreviewDialog(Me)
                Case (PrintMetod.Preview)
                    mapControl.ShowPrintPreview(Me)
                Case (PrintMetod.PreviewDialog)
                    mapControl.ShowPrintPreviewDialog(Me)
            End Select
'            #End Region ' #PrintMethods
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MapPrintOptions class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-export-a-map-to-a-file-t200511/VB/Exporting/MainWindow.xaml#L32

<dxm:MapControl.PrintOptions>
    <dxm:MapPrintOptions SizeMode="{Binding SelectedItem, ElementName=cbPrintSizeMode}" />
</dxm:MapControl.PrintOptions>

how-to-print-a-map-t200441/VB/PrintingExporting/MainWindow.xaml#L33

<dxm:MapControl.PrintOptions>
    <dxm:MapPrintOptions SizeMode="{Binding SelectedItem, ElementName=cbPrintingSize}"/>
</dxm:MapControl.PrintOptions>

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

MapDependencyObject

MapPrintOptions

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)