MSFTextStyleBuilder

Objective-C


@interface MSFTextStyleBuilder : MSFLabelStyleBuilder

Swift

class MSFTextStyleBuilder : MSFLabelStyleBuilder

A builder class for TextStyle.

  • Constructs a TextStyleBuilder object with all parameters set to defaults.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Returns the font name for the text label.

    Declaration

    Objective-C

    - (NSString *)getFontName;

    Swift

    func getFontName() -> String!

    Return Value

    The platform dependent font name for the text label.

  • Sets the font name for the text label. Accepts a CSS-like list, the most preferred name first, entries optionally tagged with the platform they are for (“android:Roboto, ios:Helvetica Neue, sans-serif”). A name the device has no font for is skipped; generic names (“sans-serif”, “serif”, “monospace”, “Arial”, …) map to the platform font.

    Declaration

    Objective-C

    - (void)setFontName:(NSString *)fontName;

    Swift

    func setFontName(_ fontName: String!)

    Parameters

    fontName

    The new platform dependent font name for the text label.

  • Returns the text field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (NSString *)getTextField;

    Swift

    func getTextField() -> String!

    Return Value

    The current text variable.

  • Sets the text field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (void)setTextField:(NSString *)field;

    Swift

    func setTextField(_ field: String!)

    Parameters

    field

    The text field to use for displaying text from metainfo.

  • Returns the font size for the text label.

    Declaration

    Objective-C

    - (float)getFontSize;

    Swift

    func getFontSize() -> Float

    Return Value

    The font size for the text label in points.

  • Sets the font size for the text label.

    Declaration

    Objective-C

    - (void)setFontSize:(float)size;

    Swift

    func setFontSize(_ size: Float)

    Parameters

    size

    The new font size for the text label in points.

  • Returns the state of the ‘break lines’ flag.

    Declaration

    Objective-C

    - (BOOL)isBreakLines;

    Swift

    func isBreakLines() -> Bool

    Return Value

    The state of the ‘break lines’ flag.

  • Sets the state of the ‘break lines’ flag. If enabled, texts containing CR or NL characters are split into multiple lines. By default the flag is false, due to backward compatibility reasons.

    Declaration

    Objective-C

    - (void)setBreakLines:(BOOL)enable;

    Swift

    func setBreakLines(_ enable: Bool)

  • Returns the margins for the text.

    Declaration

    Objective-C

    - (MSFTextMargins *)getTextMargins;

    Swift

    func getTextMargins() -> MSFTextMargins!

    Return Value

    The margins for the text.

  • Sets the margins for the text. The margins will determine how much empty space should surround the text. The default is TextMargins(0, 0, 0, 0).

    Declaration

    Objective-C

    - (void)setTextMargins:(MSFTextMargins *)textMargins;

    Swift

    func setTextMargins(_ textMargins: MSFTextMargins!)

    Parameters

    textMargins

    The new margins for the text in dp.

  • Returns the stroke color for the text label.

    Declaration

    Objective-C

    - (MSFColor *)getStrokeColor;

    Swift

    func getStrokeColor() -> MSFColor!

    Return Value

    The stroke color for the text label.

  • Sets the stroke color for the text label.

    Declaration

    Objective-C

    - (void)setStrokeColor:(MSFColor *)strokeColor;

    Swift

    func setStroke(_ strokeColor: MSFColor!)

    Parameters

    strokeColor

    The new stroke color for the text label.

  • Returns the stroke width for the text label.

    Declaration

    Objective-C

    - (float)getStrokeWidth;

    Swift

    func getStrokeWidth() -> Float

    Return Value

    The stroke width for the text label in screen density independent pixels.

  • Sets the stroke width for the text label.

    Declaration

    Objective-C

    - (void)setStrokeWidth:(float)strokeWidth;

    Swift

    func setStrokeWidth(_ strokeWidth: Float)

    Parameters

    strokeWidth

    The new stroke width for the text label in screen density independent pixels.

  • Returns the border color for the text label.

    Declaration

    Objective-C

    - (MSFColor *)getBorderColor;

    Swift

    func getBorderColor() -> MSFColor!

    Return Value

    The border color for the text label.

  • Sets the border color for the text label.

    Declaration

    Objective-C

    - (void)setBorderColor:(MSFColor *)borderColor;

    Swift

    func setBorderColor(_ borderColor: MSFColor!)

    Parameters

    borderColor

    The new border color for the text label. By default the border color is transparent.

  • Returns the border width for the text label.

    Declaration

    Objective-C

    - (float)getBorderWidth;

    Swift

    func getBorderWidth() -> Float

    Return Value

    The border width for the text label in screen density independent pixels.

  • Sets the border width for the text label.

    Declaration

    Objective-C

    - (void)setBorderWidth:(float)borderWidth;

    Swift

    func setBorderWidth(_ borderWidth: Float)

    Parameters

    borderWidth

    The new border width for the text label in screen density independent pixels. By default the border width is 0.

  • Returns the background color for the text label.

    Declaration

    Objective-C

    - (MSFColor *)getBackgroundColor;

    Swift

    func getBackgroundColor() -> MSFColor!

    Return Value

    The background color for the text label.

  • Sets the background color for the text label.

    Declaration

    Objective-C

    - (void)setBackgroundColor:(MSFColor *)backgroundColor;

    Swift

    func setBackgroundColor(_ backgroundColor: MSFColor!)

    Parameters

    backgroundColor

    The new background color for the text label. By default the background color is transparent.

  • Builds a new instance of the TextStyle object using previously set parameters.

    Declaration

    Objective-C

    - (MSFTextStyle *)buildStyle;

    Swift

    func buildStyle() -> MSFTextStyle!

    Return Value

    A new TextStyle object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()