SummaryMBS methods

Online Documentation   -   Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchy

New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1

The list of the   topics,   classes,   interfaces,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Back to SummaryMBS class.

SummaryMBS.Constructor(text as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a summary object based on a text string.
Example
dim s as new SummaryMBS("Hello World. This is just a test.")

MsgBox s.SentenceSummaryString(1)

text: The text string that you want to summarize.
On success the handle property is not zero.

The constructor creates a summarization object that pre-analyzes a text string to support fast summarization.
Available in Mac OS X v10.4 and later.

SummaryMBS.ParagraphAtIndex(index as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Gets a specified paragraph from the text in a summarization object.
Example
dim s as new SummaryMBS("Hello World. This is just a test.")
MsgBox s.ParagraphAtIndex(0)

index: The ordinal number of the paragraph in the original text, with the first paragraph designated by zero (this function uses zero-based indexing).

Return a string containing the specified paragraph, or "" on failure.

Available in Mac OS X v10.4 and later.

Some examples using this method:

SummaryMBS.ParagraphIndexOfParagraphs as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the array containing the ordinal number for each paragraph in the original text.

Some examples using this method:

SummaryMBS.ParagraphIndexOfSentences as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an array of indexes to map a sentence index to it's paragraph index.

Some examples using this method:

SummaryMBS.ParagraphSummaryString(numParagraphs as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Gets a text string consisting of a summary with, at most, the requested number of paragraphs.

numParagraphs: The maximum number of paragraphs you want in the summary.
Returns a string containing the requested summary.
Available in Mac OS X v10.4 and later.

SummaryMBS.RankOrderOfParagraphs as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an array with the summarization relevance rank of each paragraph in the original text.

Some examples using this method:

SummaryMBS.RankOrderOfSentences as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an array with the summarization relevance rank of each sentence in the original text.

Some examples using this method:

SummaryMBS.SentenceAtIndex(index as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Gets a specified sentence from the text in a summarization object.
Example
dim s as new SummaryMBS("Hello World. This is just a test.")
MsgBox s.SentenceAtIndex(0)

index: The ordinal number of the sentence in the original text, with the first sentence designated by zero (this function uses zero-based indexing).
Returns a string containing the specified sentence, or NULL on failure.
Available in Mac OS X v10.4 and later.

Some examples using this method:

SummaryMBS.SentenceIndexOfSentences as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an array of the ordinal number for each sentence in the original text.

Some examples using this method:

SummaryMBS.SentenceSummaryString(numSentences as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Mac MBS MacFrameworks Plugin 10.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Gets a text string consisting of a summary with, at most, the requested number of sentences.
Example
dim s as new SummaryMBS("Hello World. This is just a test.")

MsgBox s.SentenceSummaryString(1)

numSentences: The maximum number of sentences you want in the summary.
Returns a string containing the requested summary.
Available in Mac OS X v10.4 and later.

Some examples using this method:

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


💬 Ask a question or report a problem