Represents Microsoft Excel ParagraphFormat2 object. More...

#include <wxAutoExcelParagraphFormat2.h>

Inheritance diagram for wxAutoExcel::wxExcelParagraphFormat2:

Public Member Functions
MsoParagraphAlignment	GetAlignment ()
	Gets or sets a value specifying the alignment of the paragraph.

MsoBaselineAlignment	GetBaselineAlignment ()
	Gets or sets a constant that represents the vertical position of fonts in a paragraph.

void	SetBaselineAlignment (MsoBaselineAlignment baselineAlignment)
	Gets or sets a constant that represents the vertical position of fonts in a paragraph.

wxExcelBulletFormat2	GetBullet ()
	Gets a BulletFormat2 object for the paragraph.

MsoTriState	GetFarEastLineBreakLevel ()
	Gets or sets the East Asian line break control level for the specified paragraph.

void	SetFarEastLineBreakLevel (MsoTriState farEastLineBreakLevel)
	Gets or sets the East Asian line break control level for the specified paragraph.

double	GetFirstLineIndent ()
	Gets or sets the value (in points) for a first line or hanging indent.

void	SetFirstLineIndent (double firstLineIndent)
	Gets or sets the value (in points) for a first line or hanging indent.

MsoTriState	GetHangingPunctuation ()
	Determines whether hanging punctuation is enabled for the specified paragraphs.

void	SetHangingPunctuation (MsoTriState hangingPunctuation)
	Determines whether hanging punctuation is enabled for the specified paragraphs.

long	GetIndentLevel ()
	Gets or sets a value representing the indent level assigned to text in the selected paragraph.

void	SetIndentLevel (long indentLevel)
	Gets or sets a value representing the indent level assigned to text in the selected paragraph.

double	GetLeftIndent ()
	Gets or sets a value that represents the left indent value (in points) for the specified paragraphs.

void	SetLeftIndent (double leftIndent)
	Gets or sets a value that represents the left indent value (in points) for the specified paragraphs.

MsoTriState	GetLineRuleAfter ()
	Determines whether line spacing after the last line in each paragraph is set to a specific number of points or lines.

void	SetLineRuleAfter (MsoTriState lineRuleAfter)
	Determines whether line spacing after the last line in each paragraph is set to a specific number of points or lines.

MsoTriState	GetLineRuleBefore ()
	Determines whether line spacing before the first line in each paragraph is set to a specific number of points or lines.

void	SetLineRuleBefore (MsoTriState lineRuleBefore)
	Determines whether line spacing before the first line in each paragraph is set to a specific number of points or lines.

MsoTriState	GetLineRuleWithin ()
	Determines whether line spacing between base lines is set to a specific number of points or lines.

void	SetLineRuleWithin (MsoTriState lineRuleWithin)
	Determines whether line spacing between base lines is set to a specific number of points or lines.

double	GetRightIndent ()
	Gets or sets the right indent (in points) for the specified paragraphs.

void	SetRightIndent (double rightIndent)
	Gets or sets the right indent (in points) for the specified paragraphs.

double	GetSpaceAfter ()
	Gets or sets the amount of spacing (in points) after the specified paragraph.

void	SetSpaceAfter (double spaceAfter)
	Gets or sets the amount of spacing (in points) after the specified paragraph.

double	GetSpaceBefore ()
	Gets or sets the spacing (in points) before the specified paragraphs.

void	SetSpaceBefore (double spaceBefore)
	Gets or sets the spacing (in points) before the specified paragraphs.

double	GetSpaceWithin ()
	Gets or sets the amount of space between base lines in the specified paragraph, in points or lines.

void	SetSpaceWithin (double spaceWithin)
	Gets or sets the amount of space between base lines in the specified paragraph, in points or lines.

wxExcelTabStops2	GetTabStops ()
	Gets a TabStops2 collection that represents all the custom tab stops for the specified paragraphs.

MsoTextDirection	GetTextDirection ()
	Gets or sets the text direction for the specified paragraph.

void	SetTextDirection (MsoTextDirection textDirection)
	Gets or sets the text direction for the specified paragraph.

MsoTriState	GetWordWrap ()
	Determines whether the application wraps the Latin text in the middle of a word in the specified paragraphs.

void	SetWordWrap (MsoTriState wordWrap)
	Determines whether the application wraps the Latin text in the middle of a word in the specified paragraphs.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ParagraphFormat2".

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

Additional Inherited Members
Public Types inherited from wxAutoExcel::wxExcelObject
enum	ErrorFlags { Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }
	Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...

Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags.

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.

static bool	GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
	Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use.

Detailed Description

Represents Microsoft Excel ParagraphFormat2 object.

Member Function Documentation

◆ GetAlignment()

MsoParagraphAlignment wxAutoExcel::wxExcelParagraphFormat2::GetAlignment ( )

Gets or sets a value specifying the alignment of the paragraph.

MSDN documentation for ParagraphFormat2.Alignment.

◆ GetBaselineAlignment()

MsoBaselineAlignment wxAutoExcel::wxExcelParagraphFormat2::GetBaselineAlignment ( )

Gets or sets a constant that represents the vertical position of fonts in a paragraph.

MSDN documentation for ParagraphFormat2.BaselineAlignment.

◆ SetBaselineAlignment()

void wxAutoExcel::wxExcelParagraphFormat2::SetBaselineAlignment ( MsoBaselineAlignment baselineAlignment )

Gets or sets a constant that represents the vertical position of fonts in a paragraph.

MSDN documentation for ParagraphFormat2.BaselineAlignment.

◆ GetBullet()

wxExcelBulletFormat2 wxAutoExcel::wxExcelParagraphFormat2::GetBullet ( )

Gets a BulletFormat2 object for the paragraph.

MSDN documentation for ParagraphFormat2.Bullet.

◆ GetFarEastLineBreakLevel()

MsoTriState wxAutoExcel::wxExcelParagraphFormat2::GetFarEastLineBreakLevel ( )

Gets or sets the East Asian line break control level for the specified paragraph.

MSDN documentation for ParagraphFormat2.FarEastLineBreakLevel.

◆ SetFarEastLineBreakLevel()

void wxAutoExcel::wxExcelParagraphFormat2::SetFarEastLineBreakLevel ( MsoTriState farEastLineBreakLevel )

Gets or sets the East Asian line break control level for the specified paragraph.

MSDN documentation for ParagraphFormat2.FarEastLineBreakLevel.

◆ GetFirstLineIndent()

double wxAutoExcel::wxExcelParagraphFormat2::GetFirstLineIndent ( )

Gets or sets the value (in points) for a first line or hanging indent.

MSDN documentation for ParagraphFormat2.FirstLineIndent.

◆ SetFirstLineIndent()

void wxAutoExcel::wxExcelParagraphFormat2::SetFirstLineIndent ( double firstLineIndent )

Gets or sets the value (in points) for a first line or hanging indent.

MSDN documentation for ParagraphFormat2.FirstLineIndent.

◆ GetHangingPunctuation()

MsoTriState wxAutoExcel::wxExcelParagraphFormat2::GetHangingPunctuation ( )

Determines whether hanging punctuation is enabled for the specified paragraphs.

MSDN documentation for ParagraphFormat2.HangingPunctuation.

◆ SetHangingPunctuation()

void wxAutoExcel::wxExcelParagraphFormat2::SetHangingPunctuation ( MsoTriState hangingPunctuation )

Determines whether hanging punctuation is enabled for the specified paragraphs.

MSDN documentation for ParagraphFormat2.HangingPunctuation.

◆ GetIndentLevel()

long wxAutoExcel::wxExcelParagraphFormat2::GetIndentLevel ( )

Gets or sets a value representing the indent level assigned to text in the selected paragraph.

MSDN documentation for ParagraphFormat2.IndentLevel.

◆ SetIndentLevel()

void wxAutoExcel::wxExcelParagraphFormat2::SetIndentLevel ( long indentLevel )

Gets or sets a value representing the indent level assigned to text in the selected paragraph.

MSDN documentation for ParagraphFormat2.IndentLevel.

◆ GetLeftIndent()

double wxAutoExcel::wxExcelParagraphFormat2::GetLeftIndent ( )

Gets or sets a value that represents the left indent value (in points) for the specified paragraphs.

MSDN documentation for ParagraphFormat2.LeftIndent.

◆ SetLeftIndent()

void wxAutoExcel::wxExcelParagraphFormat2::SetLeftIndent ( double leftIndent )

Gets or sets a value that represents the left indent value (in points) for the specified paragraphs.

MSDN documentation for ParagraphFormat2.LeftIndent.

◆ GetLineRuleAfter()

MsoTriState wxAutoExcel::wxExcelParagraphFormat2::GetLineRuleAfter ( )

Determines whether line spacing after the last line in each paragraph is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleAfter.

◆ SetLineRuleAfter()

void wxAutoExcel::wxExcelParagraphFormat2::SetLineRuleAfter ( MsoTriState lineRuleAfter )

Determines whether line spacing after the last line in each paragraph is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleAfter.

◆ GetLineRuleBefore()

MsoTriState wxAutoExcel::wxExcelParagraphFormat2::GetLineRuleBefore ( )

Determines whether line spacing before the first line in each paragraph is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleBefore.

◆ SetLineRuleBefore()

void wxAutoExcel::wxExcelParagraphFormat2::SetLineRuleBefore ( MsoTriState lineRuleBefore )

Determines whether line spacing before the first line in each paragraph is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleBefore.

◆ GetLineRuleWithin()

MsoTriState wxAutoExcel::wxExcelParagraphFormat2::GetLineRuleWithin ( )

Determines whether line spacing between base lines is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleWithin.

◆ SetLineRuleWithin()

void wxAutoExcel::wxExcelParagraphFormat2::SetLineRuleWithin ( MsoTriState lineRuleWithin )

Determines whether line spacing between base lines is set to a specific number of points or lines.

MSDN documentation for ParagraphFormat2.LineRuleWithin.

◆ GetRightIndent()

double wxAutoExcel::wxExcelParagraphFormat2::GetRightIndent ( )

Gets or sets the right indent (in points) for the specified paragraphs.

MSDN documentation for ParagraphFormat2.RightIndent.

◆ SetRightIndent()

void wxAutoExcel::wxExcelParagraphFormat2::SetRightIndent ( double rightIndent )

Gets or sets the right indent (in points) for the specified paragraphs.

MSDN documentation for ParagraphFormat2.RightIndent.

◆ GetSpaceAfter()

double wxAutoExcel::wxExcelParagraphFormat2::GetSpaceAfter ( )

Gets or sets the amount of spacing (in points) after the specified paragraph.

MSDN documentation for ParagraphFormat2.SpaceAfter.

◆ SetSpaceAfter()

void wxAutoExcel::wxExcelParagraphFormat2::SetSpaceAfter ( double spaceAfter )

Gets or sets the amount of spacing (in points) after the specified paragraph.

MSDN documentation for ParagraphFormat2.SpaceAfter.

◆ GetSpaceBefore()

double wxAutoExcel::wxExcelParagraphFormat2::GetSpaceBefore ( )

Gets or sets the spacing (in points) before the specified paragraphs.

MSDN documentation for ParagraphFormat2.SpaceBefore.

◆ SetSpaceBefore()

void wxAutoExcel::wxExcelParagraphFormat2::SetSpaceBefore ( double spaceBefore )

Gets or sets the spacing (in points) before the specified paragraphs.

MSDN documentation for ParagraphFormat2.SpaceBefore.

◆ GetSpaceWithin()

double wxAutoExcel::wxExcelParagraphFormat2::GetSpaceWithin ( )

Gets or sets the amount of space between base lines in the specified paragraph, in points or lines.

MSDN documentation for ParagraphFormat2.SpaceWithin.

◆ SetSpaceWithin()

void wxAutoExcel::wxExcelParagraphFormat2::SetSpaceWithin ( double spaceWithin )

Gets or sets the amount of space between base lines in the specified paragraph, in points or lines.

MSDN documentation for ParagraphFormat2.SpaceWithin.

◆ GetTabStops()

wxExcelTabStops2 wxAutoExcel::wxExcelParagraphFormat2::GetTabStops ( )

Gets a TabStops2 collection that represents all the custom tab stops for the specified paragraphs.

MSDN documentation for ParagraphFormat2.TabStops.

◆ GetTextDirection()

MsoTextDirection wxAutoExcel::wxExcelParagraphFormat2::GetTextDirection ( )

Gets or sets the text direction for the specified paragraph.

MSDN documentation for ParagraphFormat2.TextDirection.

◆ SetTextDirection()

void wxAutoExcel::wxExcelParagraphFormat2::SetTextDirection ( MsoTextDirection textDirection )