TextString Method

Returns the text string that will appear on the map layout based on the mmAutoTextEvents value and the status of the MapProdInfo parameter. The pMapProdInfo parameter passed in will be "Nothing" for all mmAutoTextEvents except mmPlotNewPage and mmFinishPlot.

This method should always return a non-empty string. If nothing is provided, it is automatically set to " ".

Syntax

Visual Basic
C#

string TextString( 
   mmAutoTextEvents eTextEvent,
   IMMMapProductionInfo pMapProdInfo
)

'Declaration
 
Function TextString( _
   ByVal eTextEvent As mmAutoTextEvents, _
   ByVal pMapProdInfo As IMMMapProductionInfo _
) As String

'Usage
 
Dim instance As IMMAutoTextSource
Dim eTextEvent As mmAutoTextEvents
Dim pMapProdInfo As IMMMapProductionInfo
Dim value As String
 
value = instance.TextString(eTextEvent, pMapProdInfo)

Parameters

eTextEvent: mmAutoTextEvents
pMapProdInfo: IMMMapProductionInfo

Return Value

A boolean value indicating whether the autotext element should be refreshed

Example

The following code sample demonstrates how the IMMAutoTextSource::NeedRefresh method may be implemented.

Visual Basic Copy Code

Private Function IMMAutoTextSource_NeedRefresh(ByVal eTextEvent As Miner.Interop.FrameworkUI.mmAutoTextEvents) As Boolean

                                        IMMAutoTextSource_NeedRefresh = True

                                    End Function

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

Reference

IMMAutoTextSource Interface
IMMAutoTextSource Members