com.esri.arcgis.display
Interface IDynamicSymbolProperties2

All Superinterfaces:
IDynamicSymbolProperties, java.io.Serializable
All Known Implementing Classes:
DynamicDisplay, IDynamicSymbolProperties2Proxy

public interface IDynamicSymbolProperties2
extends IDynamicSymbolProperties, java.io.Serializable

COM Interface 'IDynamicSymbolProperties2'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to dynamic symbol properties.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDb66f411f_0244_4578_803b_4da18aeebaab
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.display.IDynamicSymbolProperties
IID23783eda_6341_4e81_b129_4d4fabd94154
 
Method Summary
 void getOffset(int dynamicSymbolType, float[] offsetX, float[] offsetY)
          Offsets the dynamic symbol.
 int getTextBoxHorizontalAlignment()
          Indicates the text box horizontal alignment for the dynamic text symbol.
 void getTextBoxMargins(float[] left, float[] top, float[] right, float[] bottom)
          Indicates the text box margins for the dynamic text symbol.
 float getTextCharacterSpacing()
          Indicates an additional space that is added to each character beyond what is defined by its character box in the TextGlyph.
 float getTextLeading()
          Indicates the text leading for the dynamic text symbol.
 void getTextSize(java.lang.String text, float[] sizeX, float[] sizeY)
          The text size in pixel screen coordinates.
 float getTextWordSpacing()
          Indicates an additional space that is added between words of the text string.
 boolean isLineContinuePattern()
          Indicates whether the line pattern is continued or restarted, for multi parts lines drawing.
 boolean isTextBoxUseDynamicFillSymbol()
          Indicates whether to use the dynamic fill symbol when drawing the text.
 boolean isTextBoxUseDynamicLineSymbol()
          Indicates whether to use the dynamic line symbol when drawing the text.
 boolean isTextRightToLeft()
          Indicates whether the text is drawn from right to left for the dynamic text symbol.
 boolean isUseReferenceScale(int dynamicSymbolType)
          Indicates whether the specified dynamic symbol will conform to map reference scale.
 void setLineContinuePattern(boolean continuePattern)
          Indicates whether the line pattern is continued or restarted, for multi parts lines drawing.
 void setOffset(int dynamicSymbolType, float offsetX, float offsetY)
          Offsets the dynamic symbol.
 void setTextBoxHorizontalAlignment(int textBoxHorizontalAlignment)
          Indicates the text box horizontal alignment for the dynamic text symbol.
 void setTextBoxMargins(float left, float top, float right, float bottom)
          Indicates the text box margins for the dynamic text symbol.
 void setTextBoxUseDynamicFillSymbol(boolean use)
          Indicates whether to use the dynamic fill symbol when drawing the text.
 void setTextBoxUseDynamicLineSymbol(boolean use)
          Indicates whether to use the dynamic line symbol when drawing the text.
 void setTextCharacterSpacing(float characterSpacing)
          Indicates an additional space that is added to each character beyond what is defined by its character box in the TextGlyph.
 void setTextLeading(float leading)
          Indicates the text leading for the dynamic text symbol.
 void setTextRightToLeft(boolean rightToLeft)
          Indicates whether the text is drawn from right to left for the dynamic text symbol.
 void setTextWordSpacing(float wordSpacing)
          Indicates an additional space that is added between words of the text string.
 void setUseReferenceScale(int dynamicSymbolType, boolean useReferenceScale)
          Indicates whether the specified dynamic symbol will conform to map reference scale.
 
Methods inherited from interface com.esri.arcgis.display.IDynamicSymbolProperties
getColor, getDynamicGlyph, getHeading, getRotationAlignment, getScale, getTextHorizontalAlignment, getTextVerticalAlignment, isSmooth, setColor, setDynamicGlyphByRef, setHeading, setRotationAlignment, setScale, setSmooth, setTextHorizontalAlignment, setTextVerticalAlignment
 

Field Detail

IIDb66f411f_0244_4578_803b_4da18aeebaab

static final int IIDb66f411f_0244_4578_803b_4da18aeebaab
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getOffset

void getOffset(int dynamicSymbolType,
               float[] offsetX,
               float[] offsetY)
               throws java.io.IOException,
                      AutomationException
Offsets the dynamic symbol.

Parameters:
dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)
offsetX - The offsetX (in/out: use single element array)
offsetY - The offsetY (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(int dynamicSymbolType,
               float offsetX,
               float offsetY)
               throws java.io.IOException,
                      AutomationException
Offsets the dynamic symbol.

Parameters:
dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)
offsetX - The offsetX (in)
offsetY - The offsetY (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseReferenceScale

boolean isUseReferenceScale(int dynamicSymbolType)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether the specified dynamic symbol will conform to map reference scale.

Parameters:
dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)
Returns:
The useReferenceScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseReferenceScale

void setUseReferenceScale(int dynamicSymbolType,
                          boolean useReferenceScale)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the specified dynamic symbol will conform to map reference scale.

Parameters:
dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)
useReferenceScale - The useReferenceScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextBoxMargins

void getTextBoxMargins(float[] left,
                       float[] top,
                       float[] right,
                       float[] bottom)
                       throws java.io.IOException,
                              AutomationException
Indicates the text box margins for the dynamic text symbol.

Parameters:
left - The left (in/out: use single element array)
top - The top (in/out: use single element array)
right - The right (in/out: use single element array)
bottom - The bottom (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoxMargins

void setTextBoxMargins(float left,
                       float top,
                       float right,
                       float bottom)
                       throws java.io.IOException,
                              AutomationException
Indicates the text box margins for the dynamic text symbol.

Parameters:
left - The left (in)
top - The top (in)
right - The right (in)
bottom - The bottom (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextBoxHorizontalAlignment

int getTextBoxHorizontalAlignment()
                                  throws java.io.IOException,
                                         AutomationException
Indicates the text box horizontal alignment for the dynamic text symbol.

Returns:
A com.esri.arcgis.display.esriTextHorizontalAlignment constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoxHorizontalAlignment

void setTextBoxHorizontalAlignment(int textBoxHorizontalAlignment)
                                   throws java.io.IOException,
                                          AutomationException
Indicates the text box horizontal alignment for the dynamic text symbol.

Parameters:
textBoxHorizontalAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTextBoxUseDynamicFillSymbol

boolean isTextBoxUseDynamicFillSymbol()
                                      throws java.io.IOException,
                                             AutomationException
Indicates whether to use the dynamic fill symbol when drawing the text.

Returns:
The use
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoxUseDynamicFillSymbol

void setTextBoxUseDynamicFillSymbol(boolean use)
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to use the dynamic fill symbol when drawing the text.

Parameters:
use - The use (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTextBoxUseDynamicLineSymbol

boolean isTextBoxUseDynamicLineSymbol()
                                      throws java.io.IOException,
                                             AutomationException
Indicates whether to use the dynamic line symbol when drawing the text.

Returns:
The use
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoxUseDynamicLineSymbol

void setTextBoxUseDynamicLineSymbol(boolean use)
                                    throws java.io.IOException,
                                           AutomationException
Indicates whether to use the dynamic line symbol when drawing the text.

Parameters:
use - The use (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextLeading

float getTextLeading()
                     throws java.io.IOException,
                            AutomationException
Indicates the text leading for the dynamic text symbol.

Returns:
The leading
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextLeading

void setTextLeading(float leading)
                    throws java.io.IOException,
                           AutomationException
Indicates the text leading for the dynamic text symbol.

Parameters:
leading - The leading (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextCharacterSpacing

float getTextCharacterSpacing()
                              throws java.io.IOException,
                                     AutomationException
Indicates an additional space that is added to each character beyond what is defined by its character box in the TextGlyph.

Returns:
The characterSpacing
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextCharacterSpacing

void setTextCharacterSpacing(float characterSpacing)
                             throws java.io.IOException,
                                    AutomationException
Indicates an additional space that is added to each character beyond what is defined by its character box in the TextGlyph.

Parameters:
characterSpacing - The characterSpacing (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextWordSpacing

float getTextWordSpacing()
                         throws java.io.IOException,
                                AutomationException
Indicates an additional space that is added between words of the text string.

Returns:
The wordSpacing
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextWordSpacing

void setTextWordSpacing(float wordSpacing)
                        throws java.io.IOException,
                               AutomationException
Indicates an additional space that is added between words of the text string.

Parameters:
wordSpacing - The wordSpacing (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTextRightToLeft

boolean isTextRightToLeft()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the text is drawn from right to left for the dynamic text symbol.

Returns:
The rightToLeft
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextRightToLeft

void setTextRightToLeft(boolean rightToLeft)
                        throws java.io.IOException,
                               AutomationException
Indicates whether the text is drawn from right to left for the dynamic text symbol.

Parameters:
rightToLeft - The rightToLeft (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSize

void getTextSize(java.lang.String text,
                 float[] sizeX,
                 float[] sizeY)
                 throws java.io.IOException,
                        AutomationException
The text size in pixel screen coordinates.

Parameters:
text - The text (in)
sizeX - The sizeX (in/out: use single element array)
sizeY - The sizeY (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineContinuePattern

void setLineContinuePattern(boolean continuePattern)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether the line pattern is continued or restarted, for multi parts lines drawing.

Parameters:
continuePattern - The continuePattern (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLineContinuePattern

boolean isLineContinuePattern()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether the line pattern is continued or restarted, for multi parts lines drawing.

Returns:
The continuePattern
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.