GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
PrintWidget Class
The Print widget connects your application with a printing service to allow the map to be printed.
ArcGIS Maps SDK for JavaScript
public class PrintWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object š” Microsoft.AspNetCore.Components.ComponentBase š” dymaptic.GeoBlazor.Core.Components.MapComponent š” dymaptic.GeoBlazor.Core.Components.Widgets.Widget š” ProWidget š” PrintWidget
Constructors
PrintWidget() Constructor
Parameterless constructor for use as a Razor Component.
public PrintWidget();
PrintWidget(string, IReadOnlyList, string, Nullable, string, Nullable, Nullable, string, MapView, Portal, Nullable, string, Nullable, string, string, IReadOnlyList, IReadOnlyList, Dictionary<string,Dictionary<string,string>>, TemplateOptions, PrintViewModel, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public PrintWidget(string? containerId=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.FileLink>? exportedLinks=null, string? extraParameters=null, System.Nullable<double> headingLevel=null, string? icon=null, System.Nullable<bool> includeDefaultTemplates=null, System.Nullable<bool> includeOrganizationTemplates=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, dymaptic.GeoBlazor.Core.Components.Portal? portal=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, string? printServiceUrl=null, System.Nullable<bool> showPrintAreaEnabled=null, string? stringAllowedFormats=null, string? stringAllowedLayouts=null, System.Collections.Generic.IReadOnlyList<string>? stringCollectionAllowedFormats=null, System.Collections.Generic.IReadOnlyList<string>? stringCollectionAllowedLayouts=null, System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,string?>?>? templateCustomTextElements=null, dymaptic.GeoBlazor.Pro.Options.TemplateOptions? templateOptions=null, dymaptic.GeoBlazor.Pro.Components.PrintViewModel? viewModel=null, System.Nullable<bool> visible=null, string? widgetId=null);
Parameters
containerId
System.String
The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.
exportedLinks
System.Collections.Generic.IReadOnlyList<FileLink>
The collection of links exported from the Print widget.
ArcGIS Maps SDK for JavaScript
extraParameters
System.String
This option allows passing extra parameters (in addition to templateOptions) to the print (export webmap) requests.
ArcGIS Maps SDK for JavaScript
headingLevel
System.Nullable<System.Double>
Indicates the heading level to use for the āExported filesā text where users can
access the exported map printout.
default 3
ArcGIS Maps SDK for JavaScript
icon
System.String
Icon which represents the widget.
default āprintā
ArcGIS Maps SDK for JavaScript
includeDefaultTemplates
System.Nullable<System.Boolean>
Indicates whether or not to include defaultTemplates.
default true
ArcGIS Maps SDK for JavaScript
includeOrganizationTemplates
System.Nullable<System.Boolean>
Indicates whether or not to include templates from an organizationās portal.
default true
ArcGIS Maps SDK for JavaScript
label
System.String
The widgetās default label.
ArcGIS Maps SDK for JavaScript
mapView
dymaptic.GeoBlazor.Core.Components.Views.MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
portal
dymaptic.GeoBlazor.Core.Components.Portal
It is possible to search a specified portal instanceās locator services.
ArcGIS Maps SDK for JavaScript
position
System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition>
The position of the widget in relation to the map view.
printServiceUrl
System.String
The URL of the REST endpoint of the Export Web Map Task.
ArcGIS Maps SDK for JavaScript
showPrintAreaEnabled
System.Nullable<System.Boolean>
The initial state of the print area toggle in the Print widget UI.
default false
ArcGIS Maps SDK for JavaScript
stringAllowedFormats
System.String
Specify the print output file format(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
stringAllowedLayouts
System.String
Specify the print output layout(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
stringCollectionAllowedFormats
System.Collections.Generic.IReadOnlyList<System.String>
Specify the print output file format(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
stringCollectionAllowedLayouts
System.Collections.Generic.IReadOnlyList<System.String>
Specify the print output layout(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
templateCustomTextElements
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.Dictionary<System.String,System.String>>
An object containing an array of customTextElements
name-value pair objects
for each print template in a custom print service.
ArcGIS Maps SDK for JavaScript
templateOptions
TemplateOptions
Defines the layout template options used by the Print widget to generate the print page.
ArcGIS Maps SDK for JavaScript
viewModel
PrintViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visible
System.Nullable<System.Boolean>
Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript
widgetId
System.String
The unique ID assigned to the widget when the widget is created.
ArcGIS Maps SDK for JavaScript
Properties
PrintWidget.ExportedLinks Property
The collection of links exported from the Print widget.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.FileLink>? ExportedLinks { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<FileLink>
PrintWidget.ExtraParameters Property
This option allows passing extra parameters (in addition to templateOptions) to the print (export webmap) requests.
ArcGIS Maps SDK for JavaScript
public string? ExtraParameters { get; set; }
Property Value
PrintWidget.HasCompleteListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasCompleteListener { get; }
Property Value
PrintWidget.HasSubmitListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSubmitListener { get; }
Property Value
PrintWidget.HeadingLevel Property
Indicates the heading level to use for the āExported filesā text where users can
access the exported map printout.
default 3
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> HeadingLevel { get; set; }
Property Value
System.Nullable<System.Double>
PrintWidget.IncludeDefaultTemplates Property
Indicates whether or not to include defaultTemplates.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IncludeDefaultTemplates { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintWidget.IncludeOrganizationTemplates Property
Indicates whether or not to include templates from an organizationās portal.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IncludeOrganizationTemplates { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintWidget.OnComplete Property
Event Listener for Complete.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.PrintCompleteEvent> OnComplete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<PrintCompleteEvent>
PrintWidget.OnSubmit Property
Event Listener for Submit.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.PrintSubmitEvent> OnSubmit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<PrintSubmitEvent>
PrintWidget.Portal Property
It is possible to search a specified portal instanceās locator services.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Portal? Portal { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Portal
PrintWidget.PrintServiceUrl Property
The URL of the REST endpoint of the Export Web Map Task.
ArcGIS Maps SDK for JavaScript
public string? PrintServiceUrl { get; set; }
Property Value
PrintWidget.ShowPrintAreaEnabled Property
The initial state of the print area toggle in the Print widget UI.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ShowPrintAreaEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
PrintWidget.StringAllowedFormats Property
Specify the print output file format(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
public string? StringAllowedFormats { get; set; }
Property Value
PrintWidget.StringAllowedLayouts Property
Specify the print output layout(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
public string? StringAllowedLayouts { get; set; }
Property Value
PrintWidget.StringCollectionAllowedFormats Property
Specify the print output file format(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? StringCollectionAllowedFormats { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PrintWidget.StringCollectionAllowedLayouts Property
Specify the print output layout(s) that the user can select based on the options available from the print service.
default āallā
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? StringCollectionAllowedLayouts { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PrintWidget.TemplateCustomTextElements Property
An object containing an array of customTextElements
name-value pair objects
for each print template in a custom print service.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,string?>?>? TemplateCustomTextElements { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.Dictionary<System.String,System.String>>
PrintWidget.TemplateOptions Property
Defines the layout template options used by the Print widget to generate the print page.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Options.TemplateOptions? TemplateOptions { get; set; }
Property Value
PrintWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
PrintWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.PrintViewModel? ViewModel { get; set; }
Property Value
Methods
PrintWidget.AddToExportedLinks(FileLink[]) Method
Asynchronously adds elements to the ExportedLinks property.
public System.Threading.Tasks.Task AddToExportedLinks(params dymaptic.GeoBlazor.Pro.Model.FileLink[] values);
Parameters
The elements to add.
Returns
PrintWidget.GetExportedLinks() Method
Asynchronously retrieve the current value of the ExportedLinks property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.FileLink>?> GetExportedLinks();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<FileLink>>
PrintWidget.GetExtraParameters() Method
Asynchronously retrieve the current value of the ExtraParameters property.
public System.Threading.Tasks.Task<string?> GetExtraParameters();
Returns
System.Threading.Tasks.Task<System.String>
PrintWidget.GetHeadingLevel() Method
Asynchronously retrieve the current value of the HeadingLevel property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetHeadingLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
PrintWidget.GetIncludeDefaultTemplates() Method
Asynchronously retrieve the current value of the IncludeDefaultTemplates property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncludeDefaultTemplates();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintWidget.GetIncludeOrganizationTemplates() Method
Asynchronously retrieve the current value of the IncludeOrganizationTemplates property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncludeOrganizationTemplates();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintWidget.GetPortal() Method
Asynchronously retrieve the current value of the Portal property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Portal?> GetPortal();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Portal>
PrintWidget.GetPrintServiceUrl() Method
Asynchronously retrieve the current value of the PrintServiceUrl property.
public System.Threading.Tasks.Task<string?> GetPrintServiceUrl();
Returns
System.Threading.Tasks.Task<System.String>
PrintWidget.GetShowPrintAreaEnabled() Method
Asynchronously retrieve the current value of the ShowPrintAreaEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetShowPrintAreaEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PrintWidget.GetStringAllowedFormats() Method
Asynchronously retrieve the current value of the StringAllowedFormats property.
public System.Threading.Tasks.Task<string?> GetStringAllowedFormats();
Returns
System.Threading.Tasks.Task<System.String>
PrintWidget.GetStringAllowedLayouts() Method
Asynchronously retrieve the current value of the StringAllowedLayouts property.
public System.Threading.Tasks.Task<string?> GetStringAllowedLayouts();
Returns
System.Threading.Tasks.Task<System.String>
PrintWidget.GetStringCollectionAllowedFormats() Method
Asynchronously retrieve the current value of the StringCollectionAllowedFormats property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetStringCollectionAllowedFormats();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PrintWidget.GetStringCollectionAllowedLayouts() Method
Asynchronously retrieve the current value of the StringCollectionAllowedLayouts property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetStringCollectionAllowedLayouts();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PrintWidget.GetTemplateCustomTextElements() Method
Asynchronously retrieve the current value of the TemplateCustomTextElements property.
public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,string?>?>?> GetTemplateCustomTextElements();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.Dictionary<System.String,System.String>>>
PrintWidget.GetTemplateOptions() Method
Asynchronously retrieve the current value of the TemplateOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.TemplateOptions?> GetTemplateOptions();
Returns
System.Threading.Tasks.Task<TemplateOptions>
PrintWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.PrintViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<PrintViewModel>
PrintWidget.OnJsComplete(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsComplete(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef
Microsoft.JSInterop.IJSStreamReference
Returns
PrintWidget.OnJsSubmit(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSubmit(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef
Microsoft.JSInterop.IJSStreamReference
Returns
PrintWidget.RemoveFromExportedLinks(FileLink[]) Method
Asynchronously remove an element from the ExportedLinks property.
public System.Threading.Tasks.Task RemoveFromExportedLinks(params dymaptic.GeoBlazor.Pro.Model.FileLink[] values);
Parameters
The elements to remove.
Returns
PrintWidget.SetExportedLinks(IReadOnlyList) Method
Asynchronously set the value of the ExportedLinks property after render.
public System.Threading.Tasks.Task SetExportedLinks(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Model.FileLink>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<FileLink>
The value to set.
Returns
PrintWidget.SetExtraParameters(string) Method
Asynchronously set the value of the ExtraParameters property after render.
public System.Threading.Tasks.Task SetExtraParameters(string? value);
Parameters
value
System.String
The value to set.
Returns
PrintWidget.SetHeadingLevel(Nullable) Method
Asynchronously set the value of the HeadingLevel property after render.
public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<double> value);
Parameters
value
System.Nullable<System.Double>
The value to set.
Returns
PrintWidget.SetIncludeDefaultTemplates(Nullable) Method
Asynchronously set the value of the IncludeDefaultTemplates property after render.
public System.Threading.Tasks.Task SetIncludeDefaultTemplates(System.Nullable<bool> value);
Parameters
value
System.Nullable<System.Boolean>
The value to set.
Returns
PrintWidget.SetIncludeOrganizationTemplates(Nullable) Method
Asynchronously set the value of the IncludeOrganizationTemplates property after render.
public System.Threading.Tasks.Task SetIncludeOrganizationTemplates(System.Nullable<bool> value);
Parameters
value
System.Nullable<System.Boolean>
The value to set.
Returns
PrintWidget.SetPortal(Portal) Method
Asynchronously set the value of the Portal property after render.
public System.Threading.Tasks.Task SetPortal(dymaptic.GeoBlazor.Core.Components.Portal? value);
Parameters
value
dymaptic.GeoBlazor.Core.Components.Portal
The value to set.
Returns
PrintWidget.SetPrintServiceUrl(string) Method
Asynchronously set the value of the PrintServiceUrl property after render.
public System.Threading.Tasks.Task SetPrintServiceUrl(string? value);
Parameters
value
System.String
The value to set.
Returns
PrintWidget.SetShowPrintAreaEnabled(Nullable) Method
Asynchronously set the value of the ShowPrintAreaEnabled property after render.
public System.Threading.Tasks.Task SetShowPrintAreaEnabled(System.Nullable<bool> value);
Parameters
value
System.Nullable<System.Boolean>
The value to set.
Returns
PrintWidget.SetStringAllowedFormats(string) Method
Asynchronously set the value of the StringAllowedFormats property after render.
public System.Threading.Tasks.Task SetStringAllowedFormats(string? value);
Parameters
value
System.String
The value to set.
Returns
PrintWidget.SetStringAllowedLayouts(string) Method
Asynchronously set the value of the StringAllowedLayouts property after render.
public System.Threading.Tasks.Task SetStringAllowedLayouts(string? value);
Parameters
value
System.String
The value to set.
Returns
PrintWidget.SetStringCollectionAllowedFormats(IReadOnlyList) Method
Asynchronously set the value of the StringCollectionAllowedFormats property after render.
public System.Threading.Tasks.Task SetStringCollectionAllowedFormats(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PrintWidget.SetStringCollectionAllowedLayouts(IReadOnlyList) Method
Asynchronously set the value of the StringCollectionAllowedLayouts property after render.
public System.Threading.Tasks.Task SetStringCollectionAllowedLayouts(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value
System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PrintWidget.SetTemplateCustomTextElements(Dictionary<string,Dictionary<string,stringĀ») Method
Asynchronously set the value of the TemplateCustomTextElements property after render.
public System.Threading.Tasks.Task SetTemplateCustomTextElements(System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,string?>?>? value);
Parameters
value
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.Dictionary<System.String,System.String>>
The value to set.
Returns
PrintWidget.SetTemplateOptions(TemplateOptions) Method
Asynchronously set the value of the TemplateOptions property after render.
public System.Threading.Tasks.Task SetTemplateOptions(dymaptic.GeoBlazor.Pro.Options.TemplateOptions? value);
Parameters
value
TemplateOptions
The value to set.
Returns
PrintWidget.SetViewModel(PrintViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.PrintViewModel? value);
Parameters
value
PrintViewModel
The value to set.
Returns
PrintWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()