API Reference
Class
ScrollingText
Displays a hierarchical scrolling text section with a navigation sidebar.
Inheritance
- Element
- ScrollingText
Remarks
Each ScrollingText instance collects ScrollingTextItem objects which are rendered in order. The control automatically registers the required JavaScript libraries when attached to a document.
Constructors
public ScrollingText() #Initializes a new instance of the ScrollingText class.
Methods
public ScrollingTextItem AddItem(String title, Action<ScrollingTextItem> contentAction) #Returns:
ScrollingTextItemAdds a new item to the scrolling text sequence.
Parameters
- title System.String
- Display title for the item.
- contentAction System.Action{HtmlForgeX.ScrollingTextItem}
- Callback used to populate the item contents.
Returns
The created ScrollingTextItem instance.
GenerateCustomStyles() #Generates custom CSS styles based on configuration.
Returns
CSS style rules as a string.
RegisterLibraries() #Registers the required libraries for ScrollingText.
public ScrollingText Settings(Action<ScrollingTextSettings> configure) #Returns:
ScrollingTextGroups less-common options under a single fluent entry point to keep IntelliSense lean.
Parameters
- configure System.Action{HtmlForgeX.ScrollingTextSettings}
public override String ToString() #Returns:
StringRenders the control as HTML.
Returns
A string containing the rendered HTML.
public ScrollingText WithAlignment(String alignment) #Returns:
ScrollingTextSets the content alignment (left, center, or auto).
Parameters
- alignment System.String
- The alignment value ("left", "center", or "auto").
Returns
The current instance for method chaining.
public ScrollingText WithCenteredContent() #Returns:
ScrollingTextCenters the content with auto margins.
Returns
The current instance for method chaining.
public ScrollingText WithCompactMode() #Returns:
ScrollingTextEnables compact mode with reduced spacing.
Returns
The current instance for method chaining.
public ScrollingText WithContainer() #Returns:
ScrollingTextWraps the component in a container for consistent alignment with other page content.
Returns
The current instance for method chaining.
public ScrollingText WithContentWidth(String width) #Returns:
ScrollingTextSets the content width as a percentage.
Parameters
- width System.String
- The width percentage (e.g., "100%", "80%").
Returns
The current instance for method chaining.
public ScrollingText WithFullWidth() #Returns:
ScrollingTextSets full-width mode with no margins.
Returns
The current instance for method chaining.
public ScrollingText WithLeftAlignedContent() #Returns:
ScrollingTextLeft-aligns the content without auto margins.
Returns
The current instance for method chaining.
public ScrollingText WithMaxWidth(String maxWidth) #Returns:
ScrollingTextSets the maximum width of the content area.
Parameters
- maxWidth System.String
- The max width value (e.g., "1200px", "80em").
Returns
The current instance for method chaining.
public ScrollingText WithSectionSpacing(String spacing) #Returns:
ScrollingTextSets the spacing between sections.
Parameters
- spacing System.String
- The spacing value (e.g., "5rem", "100px").
Returns
The current instance for method chaining.
Inherited Methods
public TablerAccordion Accordion(Action<TablerAccordion> config) #Returns:
TablerAccordionInherited from Element
Parameters
- config Action<TablerAccordion>
public TablerActionsAndNotesCard ActionsAndNotesCard(Action<TablerActionsAndNotesCard> config) #Returns:
TablerActionsAndNotesCardInherited from Element
Parameters
- config Action<TablerActionsAndNotesCard>
public TablerActionSummaryCard ActionSummaryCard(Action<TablerActionSummaryCard> config) #Returns:
TablerActionSummaryCardInherited from Element
Parameters
- config Action<TablerActionSummaryCard>
public TablerActivityFeedCard ActivityFeedCard(Action<TablerActivityFeedCard> config) #Returns:
TablerActivityFeedCardInherited from Element
Parameters
- config Action<TablerActivityFeedCard>
public override Element Add(Element element) #Returns:
ElementInherited from Element
Parameters
- element Element
public TablerAlert Alert(String title, String message, TablerColor alertColor = Default, TablerAlertType alertType = Regular) #Returns:
TablerAlertInherited from Element
Parameters
- title String
- message String
- alertColor TablerColor = Default
- alertType TablerAlertType = Regular
public TablerAnalyticsSummaryCard AnalyticsSummaryCard(Action<TablerAnalyticsSummaryCard> config) #Returns:
TablerAnalyticsSummaryCardInherited from Element
Parameters
- config Action<TablerAnalyticsSummaryCard>
public ApexCharts ApexChart(Action<ApexCharts> config) #Returns:
ApexChartsInherited from Element
Parameters
- config Action<ApexCharts>
public TablerApexChartCard ApexChartCard(Action<TablerApexChartCard> config) #Returns:
TablerApexChartCardInherited from Element
Parameters
- config Action<TablerApexChartCard>
public TablerAuditLogCard AuditLogCard(Action<TablerAuditLogCard> config) #Returns:
TablerAuditLogCardInherited from Element
Parameters
- config Action<TablerAuditLogCard>
public TablerAvatar Avatar() #Returns:
TablerAvatarInherited from Element
Parameters
- config Action<TablerAvatar>
public TablerAvatarGroup AvatarGroup(Action<TablerAvatarGroup> config) #Returns:
TablerAvatarGroupInherited from Element
Parameters
- config Action<TablerAvatarGroup>
public TablerBadge Badge(String text, TablerBadgeColor color, TablerBadgeVisualStyle style, TablerBadgeSize size, Boolean pill = true, String href = null) #Returns:
TablerBadgeInherited from Element
Parameters
- text String
- color TablerBadgeColor = null
public TablerBadgeSpan BadgeSpan(String text, TablerColor color = Blue) #Returns:
TablerBadgeSpanInherited from Element
Parameters
- text String
- color TablerColor = Blue
public TablerBadgeStatus BadgeStatus(String text, TablerColor color) #Returns:
TablerBadgeStatusInherited from Element
Parameters
- text String
- color TablerColor
public TablerBreakdownCard BreakdownCard(Action<TablerBreakdownCard> config) #Returns:
TablerBreakdownCardInherited from Element
Parameters
- config Action<TablerBreakdownCard>
public TablerButton Button(String text, TablerButtonVariant variant = Primary) #Returns:
TablerButtonInherited from Element
Parameters
- text String
- config Action<TablerButton> = Primary
public TablerCalendarWorkspaceCard CalendarWorkspaceCard(Action<TablerCalendarWorkspaceCard> config) #Returns:
TablerCalendarWorkspaceCardInherited from Element
Parameters
- config Action<TablerCalendarWorkspaceCard>
public TablerCard Card(Int32 count, Action<TablerCard> config) #Returns:
TablerCardInherited from Element
Parameters
- config Action<TablerCard>
public TablerCardBasic CardBasic(String title, String text) #Returns:
TablerCardBasicInherited from Element
Parameters
- title String
- text String
public TablerCarousel Carousel(Action<TablerCarousel> config) #Returns:
TablerCarouselInherited from Element
Parameters
- config Action<TablerCarousel>
public TablerCategoryBarChartCard CategoryBarChartCard(Action<TablerCategoryBarChartCard> config) #Returns:
TablerCategoryBarChartCardInherited from Element
Parameters
- config Action<TablerCategoryBarChartCard>
public ChartJs ChartJs(Action<ChartJs> config) #Returns:
ChartJsInherited from Element
Parameters
- config Action<ChartJs>
public TablerColumn Column(TablerColumnNumber number, Action<TablerColumn> config) #Returns:
TablerColumnInherited from Element
Parameters
- config Action<TablerColumn>
public TablerControlBar ControlBar(Action<TablerControlBar> config) #Returns:
TablerControlBarInherited from Element
Parameters
- config Action<TablerControlBar>
public TablerCookieBanner CookieBanner(Action<TablerCookieBanner> config) #Returns:
TablerCookieBannerInherited from Element
Parameters
- config Action<TablerCookieBanner>
public TablerCountdown Countdown(Action<TablerCountdown> config = null) #Returns:
TablerCountdownInherited from Element
Parameters
- config Action<TablerCountdown> = null
public TablerCountUp CountUp(Action<TablerCountUp> config) #Returns:
TablerCountUpInherited from Element
Parameters
- config Action<TablerCountUp>
public TablerDataGrid DataGrid(Action<TablerDataGrid> config) #Returns:
TablerDataGridInherited from Element
Parameters
- config Action<TablerDataGrid>
public TablerDataGridCard DataGridCard(Action<TablerDataGridCard> config) #Returns:
TablerDataGridCardInherited from Element
Parameters
- config Action<TablerDataGridCard>
public TablerDataTableCard DataTableCard(Action<TablerDataTableCard> config) #Returns:
TablerDataTableCardInherited from Element
Parameters
- config Action<TablerDataTableCard>
public VisNetwork DiagramNetwork(Action<VisNetwork> config) #Returns:
VisNetworkInherited from Element
Parameters
- config Action<VisNetwork>
public TablerDistributionCard DistributionCard(Action<TablerDistributionCard> config) #Returns:
TablerDistributionCardInherited from Element
Parameters
- config Action<TablerDistributionCard>
public HtmlTag Div(Action<HtmlTag> config) #Returns:
HtmlTagInherited from Element
Parameters
- config Action<HtmlTag>
public TablerEmptyState EmptyState(Action<TablerEmptyState> config) #Returns:
TablerEmptyStateInherited from Element
Parameters
- config Action<TablerEmptyState>
public TablerEmptyStateCard EmptyStateCard(Action<TablerEmptyStateCard> config) #Returns:
TablerEmptyStateCardInherited from Element
Parameters
- config Action<TablerEmptyStateCard>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public FancyTree FancyTree(Action<FancyTree> config) #Returns:
FancyTreeInherited from Element
Parameters
- config Action<FancyTree>
public TablerFlagIcon Flag(Country country) #Returns:
TablerFlagIconInherited from Element
Parameters
- iso2 String
public TablerFlagList Flags(Action<TablerFlagList> config) #Returns:
TablerFlagListInherited from Element
Parameters
- config Action<TablerFlagList>
public TablerForm Form(Action<TablerForm> config) #Returns:
TablerFormInherited from Element
Parameters
- config Action<TablerForm>
public FullCalendar FullCalendar(Action<FullCalendar> config) #Returns:
FullCalendarInherited from Element
Parameters
- config Action<FullCalendar>
public TablerGaugeCard GaugeCard(Action<TablerGaugeCard> config) #Returns:
TablerGaugeCardInherited from Element
Parameters
- config Action<TablerGaugeCard>
public TablerGeoSummaryCard GeoSummaryCard(Action<TablerGeoSummaryCard> config) #Returns:
TablerGeoSummaryCardInherited from Element
Parameters
- config Action<TablerGeoSummaryCard>
public HeaderLevel HeaderLevel(HeaderLevelTag level, String text) #Returns:
HeaderLevelInherited from Element
Parameters
- level HeaderLevelTag
- text String
public TablerHeroCard HeroCard(Action<TablerHeroCard> config) #Returns:
TablerHeroCardInherited from Element
Parameters
- config Action<TablerHeroCard>
public TablerHighlightCard HighlightCard(Action<TablerHighlightCard> config) #Returns:
TablerHighlightCardInherited from Element
Parameters
- config Action<TablerHighlightCard>
public TablerIconElement Icon(TablerIconType icon, Action<TablerIconElement> config) #Returns:
TablerIconElementInherited from Element
Parameters
- icon FontAwesomeSolid
- config Action<FontAwesomeIcon> = null
public TablerIconFont IconFont(TablerIconType icon) #Returns:
TablerIconFontInherited from Element
Parameters
- icon String
public TablerIncidentTimelineCard IncidentTimelineCard(Action<TablerIncidentTimelineCard> config) #Returns:
TablerIncidentTimelineCardInherited from Element
Parameters
- config Action<TablerIncidentTimelineCard>
public TablerInsightSummaryCard InsightSummaryCard(Action<TablerInsightSummaryCard> config) #Returns:
TablerInsightSummaryCardInherited from Element
Parameters
- config Action<TablerInsightSummaryCard>
public TablerLightboxGallery LightboxGallery(Action<TablerLightboxGallery> config) #Returns:
TablerLightboxGalleryInherited from Element
Parameters
- config Action<TablerLightboxGallery>
public TablerLineComparisonCard LineComparisonCard(Action<TablerLineComparisonCard> config) #Returns:
TablerLineComparisonCardInherited from Element
Parameters
- config Action<TablerLineComparisonCard>
public TablerButton LinkButton(String text, String href, TablerButtonVariant variant = Primary) #Returns:
TablerButtonInherited from Element
Parameters
- text String
- href String
- variant TablerButtonVariant = Primary
public TablerListCard ListCard(Action<TablerListCard> config) #Returns:
TablerListCardInherited from Element
Parameters
- config Action<TablerListCard>
public TablerListGroup ListGroup(Action<TablerListGroup> config) #Returns:
TablerListGroupInherited from Element
Parameters
- config Action<TablerListGroup>
public TablerLogs Logs(List<String> code, RGBColor backgroundColor, RGBColor textColor) #Returns:
TablerLogsInherited from Element
Parameters
- code String
- theme TablerLogsTheme = Dark
- backgroundClass String = null
- textClass String = null
public TablerMapSummaryCard MapSummaryCard(Action<TablerMapSummaryCard> config) #Returns:
TablerMapSummaryCardInherited from Element
Parameters
- config Action<TablerMapSummaryCard>
public TablerMetricCard MetricCard(Action<TablerMetricCard> config) #Returns:
TablerMetricCardInherited from Element
Parameters
- config Action<TablerMetricCard>
public TablerModal Modal(Action<TablerModal> config) #Returns:
TablerModalInherited from Element
Parameters
- config Action<TablerModal>
public TablerNarrativeCard NarrativeCard(Action<TablerNarrativeCard> config) #Returns:
TablerNarrativeCardInherited from Element
Parameters
- config Action<TablerNarrativeCard>
public TablerNarrativeSummaryCard NarrativeSummaryCard(Action<TablerNarrativeSummaryCard> config) #Returns:
TablerNarrativeSummaryCardInherited from Element
Parameters
- config Action<TablerNarrativeSummaryCard>
public TablerPageHeader PageHeader(Action<TablerPageHeader> config) #Returns:
TablerPageHeaderInherited from Element
Parameters
- config Action<TablerPageHeader>
public TablerPeopleReviewCard PeopleReviewCard(Action<TablerPeopleReviewCard> config) #Returns:
TablerPeopleReviewCardInherited from Element
Parameters
- config Action<TablerPeopleReviewCard>
public TablerPlaceholder Placeholder(Action<TablerPlaceholder> config) #Returns:
TablerPlaceholderInherited from Element
Parameters
- config Action<TablerPlaceholder>
public TablerPlaceholderCard PlaceholderCard(Action<TablerPlaceholderCard> config) #Returns:
TablerPlaceholderCardInherited from Element
Parameters
- config Action<TablerPlaceholderCard>
public TablerPlaceholderContainer Placeholders(Action<TablerPlaceholderContainer> config) #Returns:
TablerPlaceholderContainerInherited from Element
Parameters
- config Action<TablerPlaceholderContainer>
public TablerPresenceListCard PresenceListCard(Action<TablerPresenceListCard> config) #Returns:
TablerPresenceListCardInherited from Element
Parameters
- config Action<TablerPresenceListCard>
public TablerProgressBar ProgressBar(TablerProgressBarType type, Int32 percentage, Nullable<TablerColor> tablerBackground = null) #Returns:
TablerProgressBarInherited from Element
Parameters
- config Action<TablerProgressBar>
public TablerProgressListCard ProgressListCard(Action<TablerProgressListCard> config) #Returns:
TablerProgressListCardInherited from Element
Parameters
- config Action<TablerProgressListCard>
public EasyQRCodeElement QRCode(String text) #Returns:
EasyQRCodeElementInherited from Element
Parameters
- text String
public QuillEditor QuillEditor(Action<QuillEditor> config = null) #Returns:
QuillEditorInherited from Element
Parameters
- config Action<QuillEditor> = null
public TablerReviewListCard ReviewListCard(Action<TablerReviewListCard> config) #Returns:
TablerReviewListCardInherited from Element
Parameters
- config Action<TablerReviewListCard>
public TablerRow Row(Action<TablerRow> config) #Returns:
TablerRowInherited from Element
Parameters
- config Action<TablerRow>
public TablerScheduleSummaryCard ScheduleSummaryCard(Action<TablerScheduleSummaryCard> config) #Returns:
TablerScheduleSummaryCardInherited from Element
Parameters
- config Action<TablerScheduleSummaryCard>
public ScrollingText ScrollingText(Action<ScrollingText> config) #Returns:
ScrollingTextInherited from Element
Parameters
- config Action<ScrollingText>
public TablerScrollSpy ScrollSpy(Action<TablerScrollSpy> config) #Returns:
TablerScrollSpyInherited from Element
Parameters
- config Action<TablerScrollSpy>
public SmartTab SmartTab(Action<SmartTab> config) #Returns:
SmartTabInherited from Element
Parameters
- config Action<SmartTab>
public SmartWizard SmartWizard(Action<SmartWizard> config) #Returns:
SmartWizardInherited from Element
Parameters
- config Action<SmartWizard>
public TablerSocialTileCard SocialTileCard(Action<TablerSocialTileCard> config) #Returns:
TablerSocialTileCardInherited from Element
Parameters
- config Action<TablerSocialTileCard>
public Span Span(String content = "") #Returns:
SpanInherited from Element
Parameters
- content String = ""
public TablerSparkline Sparkline(Action<TablerSparkline> config) #Returns:
TablerSparklineInherited from Element
Parameters
- config Action<TablerSparkline>
public TablerSpinner Spinner(Action<TablerSpinner> config) #Returns:
TablerSpinnerInherited from Element
Parameters
- config Action<TablerSpinner>
public TablerStatTileCard StatTileCard(Action<TablerStatTileCard> config) #Returns:
TablerStatTileCardInherited from Element
Parameters
- config Action<TablerStatTileCard>
public TablerStatusIndicator StatusIndicator(Action<TablerStatusIndicator> config) #Returns:
TablerStatusIndicatorInherited from Element
Parameters
- config Action<TablerStatusIndicator>
public TablerStatusStrip StatusStrip(Action<TablerStatusStrip> config) #Returns:
TablerStatusStripInherited from Element
Parameters
- config Action<TablerStatusStrip>
public TablerSummaryStrip SummaryStrip(Action<TablerSummaryStrip> config) #Returns:
TablerSummaryStripInherited from Element
Parameters
- config Action<TablerSummaryStrip>
public Table Table(Object objects, TableType tableType) #Returns:
TableInherited from Element
Parameters
- objects IEnumerable<Object>
- tableType TableType
public TablerInput TablerInput(String name, Action<TablerInput> config = null) #Returns:
TablerInputInherited from Element
Parameters
- name String
- config Action<TablerInput> = null
public TablerProgressBar TablerProgress(Action<TablerProgressBar> config) #Returns:
TablerProgressBarInherited from Element
Parameters
- config Action<TablerProgressBar>
public TablerSelect TablerSelect(String name, Action<TablerSelect> config = null) #Returns:
TablerSelectInherited from Element
Parameters
- name String
- config Action<TablerSelect> = null
public TablerSteps TablerSteps(Action<TablerSteps> config) #Returns:
TablerStepsInherited from Element
Parameters
- config Action<TablerSteps>
public TablerTextarea TablerTextarea(String name, Action<TablerTextarea> config = null) #Returns:
TablerTextareaInherited from Element
Parameters
- name String
- config Action<TablerTextarea> = null
public TablerTableSummaryCard TableSummaryCard(Action<TablerTableSummaryCard> config) #Returns:
TablerTableSummaryCardInherited from Element
Parameters
- config Action<TablerTableSummaryCard>
public TablerTabs Tabs(Action<TablerTabs> config) #Returns:
TablerTabsInherited from Element
Parameters
- config Action<TablerTabs>
public TablerTags Tags(Action<TablerTags> config) #Returns:
TablerTagsInherited from Element
Parameters
- config Action<TablerTags>
public TablerTaskList Tasks(Action<TablerTaskList> config) #Returns:
TablerTaskListInherited from Element
Parameters
- config Action<TablerTaskList>
public TablerText Text() #Returns:
TablerTextInherited from Element
Parameters
- content String
- color RGBColor = null
- fontSize String = null
public TablerTimeline Timeline(Action<TablerTimeline> config) #Returns:
TablerTimelineInherited from Element
Parameters
- config Action<TablerTimeline>
public TablerTimelineSummaryCard TimelineSummaryCard(Action<TablerTimelineSummaryCard> config) #Returns:
TablerTimelineSummaryCardInherited from Element
Parameters
- config Action<TablerTimelineSummaryCard>
public TablerToast Toast(Action<TablerToast> config) #Returns:
TablerToastInherited from Element
Parameters
- title String
- message String
- type TablerToastType = Default
public TablerTrackingSummaryCard TrackingSummaryCard(Action<TablerTrackingSummaryCard> config) #Returns:
TablerTrackingSummaryCardInherited from Element
Parameters
- config Action<TablerTrackingSummaryCard>
public TablerVectorMapCard VectorMapCard(Action<TablerVectorMapCard> config) #Returns:
TablerVectorMapCardInherited from Element
Parameters
- config Action<TablerVectorMapCard>
public TablerWorkflowStepsCard WorkflowStepsCard(Action<TablerWorkflowStepsCard> config) #Returns:
TablerWorkflowStepsCardInherited from Element
Parameters
- config Action<TablerWorkflowStepsCard>
public TablerWorkflowSummaryCard WorkflowSummaryCard(Action<TablerWorkflowSummaryCard> config) #Returns:
TablerWorkflowSummaryCardInherited from Element
Parameters
- config Action<TablerWorkflowSummaryCard>
Properties
public String Id { get; set; } #Gets a unique identifier for the component.
public List<ScrollingTextItem> Items { get; set; } #Gets the list of items displayed by the control.
public String SectionSpacing { get; set; } #Gets or sets the spacing between sections (default: 20rem).
public String MaxWidth { get; set; } #Gets or sets the maximum width of the content (default: 100em).
public String ContentWidth { get; set; } #Gets or sets the content width percentage (default: 90%).
public Boolean CompactMode { get; set; } #Gets or sets whether to use compact spacing (reduces section padding).
public String ContentAlignment { get; set; } #Gets or sets the content alignment (default: "center" for 90% width, "left" for 100% width).
public Boolean UseContainer { get; set; } #Gets or sets whether to wrap the entire component in a container for consistent alignment.