FlexReport for WinForms | ComponentOne
C1.Win.FlexReport.CustomFields.4.5.2 Assembly / C1.Win.FlexReport.CustomFields Namespace / Map Class
Properties Methods Events


In This Topic
    Map Class Members
    In This Topic

    The following tables list the members exposed by Map.

    Public Constructors
     NameDescription
    Public ConstructorMap ConstructorInitializes a new instance of the Map class.  
    Top
    Public Properties
     NameDescription
    Public PropertyActualRightToLeftGets the actual right-to-left value that is being used. If the field's own C1.Win.FlexReport.FieldBase.RightToLeft is not null, that value is returned. Otherwise the C1.Win.FlexReport.FieldBase.ActualRightToLeft defined on the report is returned. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyActualTileSourceGets the actual tile source used by the Map.  
    Public PropertyAlignGets or sets the text alignment within the field. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyAnchorGets or sets a value determining how the field's vertical position changes relative to its containing C1.Win.FlexReport.FieldBase.SubSection. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyAutoCenterGets or sets a value indicating whether to automatically center the map around the spatial data. Note that setting this property to false effectively turns off AutoZoom.

    The default is true.

     
    Public PropertyAutoHeightGets or sets a value determining how height of object changes depending on its content. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyAutoWidthGets or sets a value determining how width of object changes depending on its content. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyAutoZoomGets or sets a value indicating whether the map should automatically zoom in to just include all spatial data. Ignored (considered to be false) if AutoCenter is false.

    The default is true.

     
    Public PropertyAutoZoomPadLatGets or sets auto zoom latitude padding, in percent relative to the viewport height.

    The default is 10%.

     
    Public PropertyAutoZoomPadLonGets or sets auto zoom longitude padding, in percent relative to the viewport width.

    The default is 10%.

     
    Public PropertyBackColorGets or sets the field's background color, this property works via C1.Win.FlexReport.VisualReportObject.Background property using C1.Win.C1Document.C1SolidBrush. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBackgroundGets or sets the C1.Win.C1Document.C1Brush object determining the object's background. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBarCodeGets or sets a value indicating whether the field should render as barcode. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyBarcodeOptionsGets the C1.Win.FlexReport.Field.BarcodeOptions object which allows to define various barcode-related options. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyBookmarkGets or sets a C1.Win.FlexReport.ScriptStringValue yielding the bookmark associated with the current object. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBorderGets or sets the C1.Win.FlexReport.VisualReportObject.Border object determining how borders are drawn around the object. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBorderColorGets or sets the field's border color. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyBordersSplitHorzModeGets or sets a value determining how borders are drawn if the object is too wide and is split between horizontal pages. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBordersSplitVertModeGets or sets a value determining how borders are drawn if the object is too high and is split between pages. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyBorderStyleGets or sets the field's border style. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyBottomGets the y-coordinate of the field's bottom edge in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyBoundsGets or sets bounds of this C1.Win.FlexReport.FieldBase object. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyCalculatedSpecifies whether the C1.Win.FlexReport.Field.Text property should be interpreted as a literal value or as a calculated expression. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyCanGrowSpecifies whether the field height should be automatically increased to fit the field's contents. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyCanShrinkSpecifies whether the field height should be automatically reduced to fit the field's contents. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyCenterLatitudeGets or sets the map center latitude. Ignored if AutoCenter is true.  
    Public PropertyCenterLongitudeGets or sets the map center longitude. Ignored if AutoCenter is true.  
    Public PropertyCheckBoxSpecifies whether the field should be displayed as a checkbox. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyCustomTileSourceGets or sets the custom tile source used by this map.  
    Public PropertyFontGets or sets the field's font. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyForcePageBreakGets or sets a value determining whether to insert page breaks before or after the field. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyForeColorGets or sets the field's foreground color. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyFormatGets or sets a string used to format the field value. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyGenericTileSourceGets the generic tile source when the TileSource is C1.Win.FlexReport.CustomFields.Maps.TileSource.Generic.  
    Public PropertyGeoCachePathGets or sets the path to the file used to cache spatial coordinates (longitude/latitude) specified as MapLocation rather than actual Longitude/Latitude values. The coordinates in such cases are retrieved using an online service such as Google, and caching them significantly imporoves performance when the same location is encountered multiple times.

    The path is relative to the application startup path.

    The default is "geocache.xml".

    Clear this value to disable caching (not recommended).

     
    Public PropertyHeightGets or sets the height of the field in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyHideDuplicatesSpecifies whether duplicate values in consecutive records should be suppressed. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyHyperlinkGets the hyperlink associated with the current field. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyImageTypeGets or sets the type of image generated by the map.  
    Public PropertyKeepTogetherSpecifies whether the field should be kept together on a page. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyKmlItemStylesGets the collection of styles used to render KML/KMZ items on the map. Styles allow KML items in different layers or even in different maps to use common visual properties.

    Note that the set accessor is only for deserialization, and should not be used directly.

     
    Public PropertyLayersGets the collection of layers containing markers, lines and KML data rendered on the map.

    Note that the set accessor is only for deserialization, and should not be used directly.

     
    Public PropertyLeftGets or sets the X coordinate of the field's left edge in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyLegendsGets the collection of legends rendered on the map. Legends may represent layers or arbitrary information (such as captions).

    Note that the set accessor is only for deserialization, and should not be used directly.

     
    Public PropertyLineSpacingGets or sets the line spacing between text lines in the field, in percent. The default is 100 which corresponds to normal line spacing.

    Note that this property is ignored if C1.Win.FlexReport.Field.RTF is true.

    (Inherited from C1.Win.FlexReport.Field)
    Public PropertyLineStylesGets the collection of styles used to render lines on the map. Styles allow lines in different layers or even in different maps to use common visual properties.

    Note that the set accessor is only for deserialization, and should not be used directly.

     
    Public PropertyLineWidthGets or sets the width of the field's border or line. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyLocationGets or sets the field's location within the section, in twips. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyMarginBottomGets or sets the spacing between the bottom edge of the field and its content, in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyMarginLeftGets or sets the spacing between the left edge of the field and its content, in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyMarginRightGets or sets the spacing between the right edge of the field and its content, in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyMarginTopGets or sets the spacing between the top edge of the field and its content, in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyMarkerStylesGets the collection of styles used to render markers on the map. Styles allow markers in different layers or even in different maps to use common visual properties.

    Note that the set accessor is only for deserialization, and should not be used directly.

     
    Public PropertyMaxAutoZoomGets or sets the maximum zoom level value for auto zooming. Valid values are from 0 to 20. 0 (the default) disables auto zoom limiting.  
    Public PropertyNameGets or sets the field name. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyOutlineLabelGets or sets a C1.Win.FlexReport.ScriptStringValue yielding the label associated with the object in the outline tree. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyOutlineParentGets or sets the name of the object that will be the parent of the current object in the outline tree. If unspecified, the report hierarchy will be used to determine the parent. (Inherited from C1.Win.FlexReport.VisualReportObject)
    Public PropertyParentReportGets the C1.Win.FlexReport.C1FlexReport containing this field. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyPictureGets or sets a picture to display on the field. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyPictureAlignGets or sets how field pictures should be the aligned. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyPictureScaleGets or sets how images should be the scaled to fit within the field area. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyRenderHeightGets the actual height of the current field. This property can only be used while the report is being rendered, otherwise it returns -1. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRenderLeftGets the actual left position of the current field in its subsection. This property can only be used while the report is being rendered, otherwise it returns -1. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRenderTopGets the actual top position of the current field in its subsection. This property can only be used while the report is being rendered, otherwise it returns -1. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRenderWidthGets the actual width of the current field. This property can only be used while the report is being rendered, otherwise it returns -1. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRightGets the x-coordinate of the field's right edge in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRightToLeftGets or sets a value indicating whether right-to-left text rendering rules should be used. If null (which is the default), the property C1.Win.FlexReport.C1FlexReport.RightToLeft defined on the report is used. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyRoundAutoZoomGets or sets a value indicating whether to round automatically calculated zoom levels down to next integer.

    The default is true.

     
    Public PropertyRTFGets or sets a value indicating whether strings enclosed in curly brackets should render as RTF. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyRunningSumSpecifies whether to show a running sum for the field. (Inherited from C1.Win.FlexReport.Field)
    Public PropertySectionGets or sets the section to which the field belongs. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyShapeGets or sets an instance of the C1.Win.C1Document.ShapeBase-derived class specifying properties of the geometric shape drawn by this field (if C1.Win.FlexReport.Field.ShapeType is not None). (Inherited from C1.Win.FlexReport.Field)
    Public PropertyShapeTypeGets or sets the type of geometric shape drawn by the current field.

    The default is None.

    (Inherited from C1.Win.FlexReport.Field)
    Public PropertyShowPanToolGets or sets a value indicating whether to show the pan tool.

    The default is false.

     
    Public PropertyShowScaleGets or sets a value indicating whether to show the map scale.

    The default is true.

     
    Public PropertyShowZoomToolGets or sets a value indicating whether to show the zoom scale.

    The default is false.

     
    Public PropertySizeGets or sets the field's size, in twips. (Inherited from C1.Win.FlexReport.Field)
    Public PropertySplitHorzBehaviorGets or sets a value determining how the object is treated when it is too wide to fit in the horizontal space available on the current page. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertySplitVertBehaviorGets or sets a value determining how the object is treated when it is too high to fit in the vertical space available on the current page. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertySubreportGets or sets a reference to another report to be rendered within the field (a subreport). (Inherited from C1.Win.FlexReport.Field)
    Public PropertySubreportHasDataReturns whether a subreport has data and suppresses rendering if it doesn't. (Inherited from C1.Win.FlexReport.Field)
    Public PropertySubSectionGets the C1.Win.FlexReport.FieldBase.SubSection object containing this field. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertySubSectionIndexGets or sets the index of the C1.Win.FlexReport.FieldBase.SubSection in C1.Win.FlexReport.FieldBase.Section to which the field belongs. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyTagGets or sets arbitrary data associated with the object. (Inherited from C1.Win.FlexReport.ReportObject)
    Public PropertyTargetDpiObsoleted. Gets or sets the target image resolution (dpi).

    The default is 200 dpi.

     
    Public PropertyTextGets or sets the field's text. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyTextAngleGets or sets the angle of text rotation within the field (including barcodes). (Inherited from C1.Win.FlexReport.Field)
    Public PropertyTileSourceGets or sets the map tile source.  
    Public PropertyToolsColorGets or sets the background color of the map scale and other tools.  
    Public PropertyTopGets or sets the Y coordinate of the field's top edge in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyUseAntiAliasedGraphicsGets or sets a value indicating whether to use anti-aliasing while rendering map graphics.  
    Public PropertyValueGets or sets the field's calculated value. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyVisibleGets or sets a value indicating whether the field is visible or hidden. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyWidthGets or sets the width of the field in twips. (Inherited from C1.Win.FlexReport.FieldBase)
    Public PropertyWordWrapGets or sets a value indicating whether automatic word wrapping is on. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyWritingModeGets or sets the text writing mode: horizontal (default), vertical with left to right flow etc. (Inherited from C1.Win.FlexReport.Field)
    Public PropertyZoomLevelGets or sets the zoom level value. 0 is no zoom, 1 - x2 zoom and so on. Valid values are from 0 to 20.

    The default is 0.

    Ignored if AutoZoom is true.  
    Public PropertyZOrderGets or sets the ZOrder of the field. (Inherited from C1.Win.FlexReport.FieldBase)
    Top
    Public Methods
     NameDescription
    Public MethodAssignFromOverloaded. Overridden. Copies properties from another object into this object.  
    Public MethodCloneCreates a new object that is a copy of the current C1.Win.FlexReport.FieldBase object. (Inherited from C1.Win.FlexReport.FieldBase)
    Public MethodOnPropertyChangedOverridden. Overridden. Disposes the cached map image if any, and calls the base implementation.  
    Public MethodResetFontFor internal use. (Inherited from C1.Win.FlexReport.Field)
    Public MethodSetZOrderBrings a field to the front or sends it to the back of the ZOrder. (Inherited from C1.Win.FlexReport.FieldBase)
    Top
    Protected Methods
     NameDescription
    Protected MethodGetRenderContentOverridden. Assigns the map image that will be rendered by the field.  
    Protected MethodLoadOverridden. Overridden. Loads map specific collections.  
    Protected MethodOnSerializeAddedOverridden. Overriden. Post action after the Map is added to the parent report's fields collection.  
    Protected MethodSaveOverridden. Overridden. Saves map specific collections.  
    Top
    Public Events
     NameDescription
    Public EventLayersChangedFired when the Layers collection is set.  
    Top
    See Also

    Reference

    Map Class
    C1.Win.FlexReport.CustomFields Namespace