Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

NSParagraphStyleMBS.alignment as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the text alignment of the receiver.
Example:
dim n as NSParagraphStyleMBS = NSParagraphStyleMBS.defaultParagraphStyle
MsgBox str(n.alignment) // 4 = natural

dim m as NSMutableParagraphStyleMBS = n.mutableCopy
m.setAlignment NSParagraphStyleMBS.NSCenterTextAlignment
MsgBox str(m.alignment) // 2 = center
Notes:
Natural text alignment is realized as left or right alignment depending on the line sweep direction of the first script contained in the paragraph.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.baseWritingDirection as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the base writing direction for the receiver.
Notes: (Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.defaultTabInterval as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the document-wide default tab interval.
Notes:
The default tab interval in points. Tabs after the last specified in tabStops are placed at integer multiples of this distance (if positive). Default return value is 0.0.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.firstLineHeadIndent as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the indentation of the first line of the receiver.
Notes:
The distance in points from the leading margin of a text container to the beginning of the paragraph's first line. This value is always nonnegative.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.firstTabStop as NSTextTabMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 18.1 Yes No No Yes, macOS only No
Function: The first tab stop entry.
Notes:
For debugging.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.firstTextList as NSTextListMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 18.1 Yes No No Yes, macOS only No
Function: The first text list entry.
Notes:
For debugging.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: The internal object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.headerLevel as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Specifies whether the paragraph is to be treated as a header for purposes of HTML generation.
Notes:
Returns 0 (the default value), if the paragraph is not a header, or from 1 through 6 if the paragraph is to be treated as a header.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.headIndent as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the indentation of the receiver's lines other than the first.
Notes:
The distance in points from the leading margin of a text container to the beginning of lines other than the first. This value is always nonnegative.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.hyphenationFactor as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the paragraph's threshold for hyphenation.
Notes:
A value between 0.0 and 1.0 inclusive. The default value is 0.0.

Hyphenation is attempted when the ratio of the text width (as broken without hyphenation) to the width of the line fragment is less than the hyphenation factor. When the paragraph's hyphenation factor is 0.0, the layout manager's hyphenation factor is used instead. When both are 0.0, hyphenation is disabled.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.lineBreakMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the mode that should be used to break lines in the receiver.
Notes:
The line break mode to be used laying out the paragraph's text.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.lineHeightMultiple as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the line height multiple.
Notes:
The line height multiple. The natural line height of the receiver is multiplied by this factor (if positive) before being constrained by minimum and maximum line height. Default return value is 0.0.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.lineSpacing as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the space between lines in the receiver (commonly known as leading).
Notes:
The space in points added between lines within the paragraph. This value is always nonnegative.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.maximumLineHeight as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the receiver's maximum line height.
Notes:
The maximum height in points that any line in the receiver will occupy, regardless of the font size or size of any attached graphic. This value is always nonnegative. The default value is 0.

Glyphs and graphics exceeding this height will overlap neighboring lines; however, a maximum height of 0 implies no line height limit. Although this limit applies to the line itself, line spacing adds extra space between adjacent lines.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.minimumLineHeight as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the receiver's minimum height.
Notes:
The minimum height in points that any line in the receiver will occupy, regardless of the font size or size of any attached graphic. This value is always nonnegative.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.paragraphSpacing as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the space after the end of the paragraph.
Notes:
The space in points added at the end of the paragraph to separate it from the following paragraph. This value is always nonnegative.

This value is determined by adding the previous paragraph's paragraphSpacing and the current paragraph's paragraphSpacingBefore.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.paragraphSpacingBefore as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the distance between the paragraph's top and the beginning of its text content.
Notes:
The distance in points between the paragraph's top and the beginning of its text content. Default return value is 0.0.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.tailIndent as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the trailing indentation of the receiver.
Notes:
The distance in points from the margin of a text container to the end of lines.

If positive, this value is the distance from the leading margin (for example, the left margin in left-to-right text). If 0 or negative, it's the distance from the trailing margin.

For example, a paragraph style designed to fit exactly in a 2-inch wide container has a head indent of 0.0 and a tail indent of 0.0. One designed to fit with a quarter-inch margin has a head indent of 0.25 and a tail indent of –0.25.
(Read only property)

Feedback, Comments & Corrections

NSParagraphStyleMBS.tighteningFactorForTruncation as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacCocoa Plugin 12.4 Yes No No Yes, macOS only No
Function: Returns the threshold for using tightening as an alternative to truncation.
Notes:
The tightening threshold value. The default value is 0.05.

When the line break mode specifies truncation, the text system attempts to tighten intercharacter spacing as an alternative to truncation, provided that the ratio of the text width to the line fragment width does not exceed 1.0 + the tightening factor returned by this method. Otherwise the text is truncated at a location determined by the line break mode.
(Read only property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacCocoa Plugin.





Links
MBS Xojo Chart Plugins